From 7fec20cc8df4a9817a7cedf4298ddbcacfb1e84f Mon Sep 17 00:00:00 2001 From: General Kroll Date: Tue, 8 Feb 2022 13:28:34 +1100 Subject: [PATCH] registry-included-but-silent-by-default --- .github/workflows/go.yml | 66 + .github/workflows/goreleaser.yml | 6 + .vscode/launch.json | 142 +- CMakeLists.txt | 47 +- docs/developer_guide.md | 6 +- docs/examples.md | 21 +- examples/README.md | 23 + examples/empty-registry/.gitignore | 3 + examples/empty-registry/src/.gitignore | 2 + .../registry/src/publicapis/v1/provider.yaml | 16 + .../src/publicapis/v1/services/api-v1.yaml | 209 + go.mod | 16 +- go.sum | 254 + internal/pkg/pgp/pgp.go | 98 + internal/stackql/asyncmonitor/asyncmonitor.go | 6 +- internal/stackql/cache/marshall.go | 92 - internal/stackql/cache/ttl_kv_cache.go | 185 - internal/stackql/cmd/exec.go | 6 +- internal/stackql/cmd/registry.go | 63 + internal/stackql/cmd/root.go | 27 +- internal/stackql/cmd/shell.go | 33 +- internal/stackql/config/config.go | 22 +- internal/stackql/constants/constants.go | 5 +- internal/stackql/discovery/discovery.go | 117 +- ...regation_compute_disks_integration_test.go | 11 +- ..._container_subnetworks_integration_test.go | 5 +- ...aginated_compute_disks_integration_test.go | 11 +- .../dependent_simple_integration_test.go | 9 +- .../stackql/driver/driver_integration_test.go | 15 +- .../driver/functions_integration_test.go | 7 +- .../stackql/driver/okta_integration_test.go | 5 +- .../routine_complex_integration_test.go | 3 +- .../driver/show_insert_integration_test.go | 7 +- .../driver/show_various_integration_test.go | 7 +- internal/stackql/dto/dto.go | 201 +- internal/stackql/google_sdk/gcloud.go | 2 +- internal/stackql/handler/handler.go | 74 +- internal/stackql/httpbuild/request.go | 17 +- internal/stackql/httpexec/httpexec.go | 19 +- internal/stackql/iqlerror/iqlerror.go | 5 + internal/stackql/methodselect/methodselect.go | 16 +- internal/stackql/netutils/http_proxy.go | 65 +- .../planbuilder/primitive_generator.go | 3 +- .../stackql/planbuilder/statement_analyzer.go | 17 +- internal/stackql/primitivebuilder/builder.go | 6 + internal/stackql/provider/auth_util.go | 101 +- internal/stackql/provider/generic.go | 34 +- internal/stackql/provider/google.go | 12 - internal/stackql/provider/provider.go | 38 +- .../querysubmit_integration_test.go | 3 +- internal/stackql/taxonomy/taxonomy.go | 19 +- internal/stackql/util/utility.go | 8 + internal/test/stackqltestutil/locator.go | 23 +- internal/test/testobjects/input.go | 4 + stackql/.gitignore | 1 + stackql/main_integration_test.go | 21 +- .../google/functional-test-dummy-sa-key.json | 12 + ...plated-show-services-extended-filtered.iql | 2 +- ...plated-show-services-extended-filtered.iql | 2 +- ...plated-show-services-extended-filtered.iql | 2 +- test/downloads/.gitignore | 2 + test/dummyserver/dummy_server.py | 47 - test/empty/.gitignore | 2 + test/functional/.gitignore | 7 + test/functional/README.md | 17 + test/functional/stackql_from_cmd_line.robot | 24 + .../stackql_mocked_from_cmd_line.robot | 60 + test/functional/variables/__init__.py | 0 test/functional/variables/stackql_context.py | 63 + test/python/main.py | 32 +- test/python/registry-rewrite.py | 66 + test/registry-mocked/.gitignore | 2 + .../src/googleapis.com/v1/provider.yaml | 4376 + .../src/googleapis.com/v1/provider.yaml.sig | 1 + .../v1/resources/compute-v1.yaml | 5722 ++ .../v1/resources/compute-v1.yaml.sig | 1 + .../compute/compute-disks-v1.yaml | 28106 ++++++ .../compute/compute-disks-v1.yaml.sig | 1 + .../v1/services-split/compute/compute-v1.yaml | 74397 ++++++++++++++++ .../compute/compute-v1.yaml.sig | 1 + .../v1/services/bigquery-v2.yaml | 8036 ++ .../v1/services/bigquery-v2.yaml.sig | 1 + .../v1/services/cloudresourcemanager-v3.yaml | 4674 + .../services/cloudresourcemanager-v3.yaml.sig | 1 + .../v1/services/container-v1.yaml | 8603 ++ .../v1/services/container-v1.yaml.sig | 1 + .../v1/services/storage-v1.yaml | 5489 ++ .../v1/services/storage-v1.yaml.sig | 1 + test/registry/src/okta/v1/provider.yaml | 247 + test/registry/src/okta/v1/provider.yaml.sig | 1 + .../src/okta/v1/services/Application.yaml | 2933 + .../src/okta/v1/services/Application.yaml.sig | 1 + .../src/okta/v1/services/Authenticator.yaml | 228 + .../okta/v1/services/Authenticator.yaml.sig | 1 + .../okta/v1/services/AuthorizationServer.yaml | 2582 + .../v1/services/AuthorizationServer.yaml.sig | 1 + .../registry/src/okta/v1/services/Domain.yaml | 319 + .../src/okta/v1/services/Domain.yaml.sig | 1 + .../src/okta/v1/services/EventHook.yaml | 414 + .../src/okta/v1/services/EventHook.yaml.sig | 1 + .../src/okta/v1/services/Feature.yaml | 270 + .../src/okta/v1/services/Feature.yaml.sig | 1 + test/registry/src/okta/v1/services/Group.yaml | 3075 + .../src/okta/v1/services/Group.yaml.sig | 1 + .../src/okta/v1/services/GroupSchema.yaml | 336 + .../src/okta/v1/services/GroupSchema.yaml.sig | 1 + .../okta/v1/services/IdentityProvider.yaml | 2400 + .../v1/services/IdentityProvider.yaml.sig | 1 + .../src/okta/v1/services/InlineHook.yaml | 458 + .../src/okta/v1/services/InlineHook.yaml.sig | 1 + .../src/okta/v1/services/LinkedObject.yaml | 193 + .../okta/v1/services/LinkedObject.yaml.sig | 1 + test/registry/src/okta/v1/services/Log.yaml | 420 + .../src/okta/v1/services/Log.yaml.sig | 1 + .../src/okta/v1/services/NetworkZone.yaml | 393 + .../src/okta/v1/services/NetworkZone.yaml.sig | 1 + test/registry/src/okta/v1/services/Org.yaml | 711 + .../src/okta/v1/services/Org.yaml.sig | 1 + .../registry/src/okta/v1/services/Policy.yaml | 1681 + .../src/okta/v1/services/Policy.yaml.sig | 1 + .../src/okta/v1/services/ProfileMapping.yaml | 219 + .../okta/v1/services/ProfileMapping.yaml.sig | 1 + .../src/okta/v1/services/Session.yaml | 266 + .../src/okta/v1/services/Session.yaml.sig | 1 + .../src/okta/v1/services/Template.yaml | 297 + .../src/okta/v1/services/Template.yaml.sig | 1 + .../src/okta/v1/services/ThreatInsight.yaml | 114 + .../okta/v1/services/ThreatInsight.yaml.sig | 1 + .../src/okta/v1/services/TrustedOrigin.yaml | 332 + .../okta/v1/services/TrustedOrigin.yaml.sig | 1 + test/registry/src/okta/v1/services/User.yaml | 4281 + .../src/okta/v1/services/User.yaml.sig | 1 + .../src/okta/v1/services/UserFactor.yaml | 851 + .../src/okta/v1/services/UserFactor.yaml.sig | 1 + .../src/okta/v1/services/UserSchema.yaml | 478 + .../src/okta/v1/services/UserSchema.yaml.sig | 1 + .../src/okta/v1/services/UserType.yaml | 288 + .../src/okta/v1/services/UserType.yaml.sig | 1 + test/server/README.md | 32 + .../expectations/static-gcp-expectations.json | 108 + .../always/locally-executable.json | 8 +- .../live-integration/live-integration.json | 2 +- 142 files changed, 165126 insertions(+), 820 deletions(-) create mode 100644 examples/README.md create mode 100644 examples/empty-registry/.gitignore create mode 100644 examples/empty-registry/src/.gitignore create mode 100644 examples/registry/src/publicapis/v1/provider.yaml create mode 100644 examples/registry/src/publicapis/v1/services/api-v1.yaml create mode 100644 internal/pkg/pgp/pgp.go delete mode 100644 internal/stackql/cache/marshall.go delete mode 100644 internal/stackql/cache/ttl_kv_cache.go create mode 100644 internal/stackql/cmd/registry.go delete mode 100644 internal/stackql/provider/google.go create mode 100644 stackql/.gitignore create mode 100644 test/assets/credentials/dummy/google/functional-test-dummy-sa-key.json create mode 100644 test/downloads/.gitignore delete mode 100644 test/dummyserver/dummy_server.py create mode 100644 test/empty/.gitignore create mode 100644 test/functional/.gitignore create mode 100644 test/functional/README.md create mode 100644 test/functional/stackql_from_cmd_line.robot create mode 100644 test/functional/stackql_mocked_from_cmd_line.robot create mode 100644 test/functional/variables/__init__.py create mode 100644 test/functional/variables/stackql_context.py create mode 100644 test/python/registry-rewrite.py create mode 100644 test/registry-mocked/.gitignore create mode 100644 test/registry/src/googleapis.com/v1/provider.yaml create mode 100644 test/registry/src/googleapis.com/v1/provider.yaml.sig create mode 100644 test/registry/src/googleapis.com/v1/resources/compute-v1.yaml create mode 100644 test/registry/src/googleapis.com/v1/resources/compute-v1.yaml.sig create mode 100644 test/registry/src/googleapis.com/v1/services-split/compute/compute-disks-v1.yaml create mode 100644 test/registry/src/googleapis.com/v1/services-split/compute/compute-disks-v1.yaml.sig create mode 100644 test/registry/src/googleapis.com/v1/services-split/compute/compute-v1.yaml create mode 100644 test/registry/src/googleapis.com/v1/services-split/compute/compute-v1.yaml.sig create mode 100644 test/registry/src/googleapis.com/v1/services/bigquery-v2.yaml create mode 100644 test/registry/src/googleapis.com/v1/services/bigquery-v2.yaml.sig create mode 100644 test/registry/src/googleapis.com/v1/services/cloudresourcemanager-v3.yaml create mode 100644 test/registry/src/googleapis.com/v1/services/cloudresourcemanager-v3.yaml.sig create mode 100644 test/registry/src/googleapis.com/v1/services/container-v1.yaml create mode 100644 test/registry/src/googleapis.com/v1/services/container-v1.yaml.sig create mode 100644 test/registry/src/googleapis.com/v1/services/storage-v1.yaml create mode 100644 test/registry/src/googleapis.com/v1/services/storage-v1.yaml.sig create mode 100644 test/registry/src/okta/v1/provider.yaml create mode 100644 test/registry/src/okta/v1/provider.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Application.yaml create mode 100644 test/registry/src/okta/v1/services/Application.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Authenticator.yaml create mode 100644 test/registry/src/okta/v1/services/Authenticator.yaml.sig create mode 100644 test/registry/src/okta/v1/services/AuthorizationServer.yaml create mode 100644 test/registry/src/okta/v1/services/AuthorizationServer.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Domain.yaml create mode 100644 test/registry/src/okta/v1/services/Domain.yaml.sig create mode 100644 test/registry/src/okta/v1/services/EventHook.yaml create mode 100644 test/registry/src/okta/v1/services/EventHook.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Feature.yaml create mode 100644 test/registry/src/okta/v1/services/Feature.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Group.yaml create mode 100644 test/registry/src/okta/v1/services/Group.yaml.sig create mode 100644 test/registry/src/okta/v1/services/GroupSchema.yaml create mode 100644 test/registry/src/okta/v1/services/GroupSchema.yaml.sig create mode 100644 test/registry/src/okta/v1/services/IdentityProvider.yaml create mode 100644 test/registry/src/okta/v1/services/IdentityProvider.yaml.sig create mode 100644 test/registry/src/okta/v1/services/InlineHook.yaml create mode 100644 test/registry/src/okta/v1/services/InlineHook.yaml.sig create mode 100644 test/registry/src/okta/v1/services/LinkedObject.yaml create mode 100644 test/registry/src/okta/v1/services/LinkedObject.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Log.yaml create mode 100644 test/registry/src/okta/v1/services/Log.yaml.sig create mode 100644 test/registry/src/okta/v1/services/NetworkZone.yaml create mode 100644 test/registry/src/okta/v1/services/NetworkZone.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Org.yaml create mode 100644 test/registry/src/okta/v1/services/Org.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Policy.yaml create mode 100644 test/registry/src/okta/v1/services/Policy.yaml.sig create mode 100644 test/registry/src/okta/v1/services/ProfileMapping.yaml create mode 100644 test/registry/src/okta/v1/services/ProfileMapping.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Session.yaml create mode 100644 test/registry/src/okta/v1/services/Session.yaml.sig create mode 100644 test/registry/src/okta/v1/services/Template.yaml create mode 100644 test/registry/src/okta/v1/services/Template.yaml.sig create mode 100644 test/registry/src/okta/v1/services/ThreatInsight.yaml create mode 100644 test/registry/src/okta/v1/services/ThreatInsight.yaml.sig create mode 100644 test/registry/src/okta/v1/services/TrustedOrigin.yaml create mode 100644 test/registry/src/okta/v1/services/TrustedOrigin.yaml.sig create mode 100644 test/registry/src/okta/v1/services/User.yaml create mode 100644 test/registry/src/okta/v1/services/User.yaml.sig create mode 100644 test/registry/src/okta/v1/services/UserFactor.yaml create mode 100644 test/registry/src/okta/v1/services/UserFactor.yaml.sig create mode 100644 test/registry/src/okta/v1/services/UserSchema.yaml create mode 100644 test/registry/src/okta/v1/services/UserSchema.yaml.sig create mode 100644 test/registry/src/okta/v1/services/UserType.yaml create mode 100644 test/registry/src/okta/v1/services/UserType.yaml.sig create mode 100644 test/server/README.md create mode 100644 test/server/expectations/static-gcp-expectations.json diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 9da04092..366d985f 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -36,9 +36,22 @@ jobs: uses: egor-tensin/setup-mingw@v2 id: gccsetup + - name: Get rid of disruptive line endings before checkout + run: | + git config --global core.autocrlf false + - name: Check out code into the Go module directory uses: actions/checkout@v2 + - name: Install Python dependencies + run: | + pip3 install PyYaml + pip3 install robotframework + + - name: Generate rewritten registry for simulations + run: | + python3 test\python\registry-rewrite.py + - name: Get dependencies run: | go env -w GOPRIVATE="github.com/stackql/*" @@ -97,6 +110,17 @@ jobs: - name: Test if: success() run: go test -timeout 1200s --tags "json1" -v ./... + + - name: Mock Server Download + run: | + mvn org.apache.maven.plugins:maven-dependency-plugin:3.0.2:copy ` + '-Dartifact=org.mock-server:mockserver-netty:5.12.0:jar:shaded' ` + '-DoutputDirectory=test/downloads' + + - name: Run robot tests + if: success() + run: | + cmd /c "robot test\functional" - name: Prepare Test DB if: success() @@ -132,6 +156,15 @@ jobs: - name: Check out code into the Go module directory uses: actions/checkout@v2 + + - name: Install Python dependencies + run: | + pip3 install PyYaml + pip3 install robotframework + + - name: Generate rewritten registry for simulations + run: | + python3 test/python/registry-rewrite.py - name: Get dependencies run: | @@ -180,6 +213,18 @@ jobs: - name: Test if: success() run: go test -timeout 1200s --tags "json1" -v ./... + + - name: Mock Server Download + run: | + mvn \ + org.apache.maven.plugins:maven-dependency-plugin:3.0.2:copy \ + -Dartifact=org.mock-server:mockserver-netty:5.12.0:jar:shaded \ + -DoutputDirectory=test/downloads + + - name: Run robot tests + if: success() + run: | + robot test/functional - name: Prepare Test DB if: success() @@ -211,6 +256,15 @@ jobs: - name: Check out code into the Go module directory uses: actions/checkout@v2 + - name: Install Python dependencies + run: | + pip3 install PyYaml + pip3 install robotframework + + - name: Generate rewritten registry for simulations + run: | + python3 test/python/registry-rewrite.py + - name: Get dependencies run: | git config --global url.https://$GH_ACCESS_TOKEN@github.com/.insteadOf https://github.com/ @@ -260,6 +314,18 @@ jobs: - name: Test if: success() run: go test -timeout 1200s --tags "json1" -v ./... + + - name: Mock Server Download + run: | + mvn \ + org.apache.maven.plugins:maven-dependency-plugin:3.0.2:copy \ + -Dartifact=org.mock-server:mockserver-netty:5.12.0:jar:shaded \ + -DoutputDirectory=test/downloads + + - name: Run robot tests + if: success() + run: | + robot test/functional - name: Prepare Test DB if: success() diff --git a/.github/workflows/goreleaser.yml b/.github/workflows/goreleaser.yml index dc768be6..1ef3bf43 100644 --- a/.github/workflows/goreleaser.yml +++ b/.github/workflows/goreleaser.yml @@ -10,6 +10,12 @@ jobs: goreleaser: runs-on: ubuntu-latest steps: + + + - name: Get rid of dissruptive line endings before checkout + run: | + git config --global core.autocrlf false + - name: Checkout uses: actions/checkout@v2 diff --git a/.vscode/launch.json b/.vscode/launch.json index ec6cd18f..36807593 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -79,7 +79,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "select * from google.logging.`projects.logs` WHERE parent = 'projects/lab-kr-network-01';", "-o", "json" @@ -94,7 +94,7 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--auth={ \"google\": { \"keyfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"keyfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"keyfiletype\": \"api_key\" } }", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "select name from google.compute.disks where project = 'lab-kr-network-01' and zone = 'australia-southeast1-a';", "-o", "json" @@ -109,22 +109,104 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--auth={ \"google\": { \"keyfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"keyfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"keyfiletype\": \"api_key\" } }", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "show extended resources from okta.group;", "-o", "json" ], }, - // { - "name": "SELECT using alias... ;", + "name": "DEBUG delete from google.storage.buckets ... ;", + "type": "go", + "request": "launch", + "mode": "debug", + "program": "${workspaceFolder}/stackql", + "args": [ + "exec", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", + "delete from google.storage.buckets WHERE bucket = 'lab-kr-network-03-trial-bucket';", + "-o", + "json" + ], + }, + // ' registry pull okta + { + "name": "DEBUG pull okta ... ;", + "type": "go", + "request": "launch", + "mode": "debug", + "program": "${workspaceFolder}/stackql", + "args": [ + "registry", + "--registry={ \"useEmbedded\": false, \"url\": \"https://raw.githubusercontent.com/stackql/stackql-provider-registry/intial-devel/providers\" }", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", + "pull", + "okta" + ], + }, + // { "url": "file://${workspaceFolder}/examples/registry'${PROVIDER_REGISTRY_ROOT_DIR}'", "localDocRoot": "'${PROVIDER_REGISTRY_ROOT_DIR}'", "useEmbedded": false, "verifyConfig": {"nopVerify": true } } + { + "name": "DEBUG BYO describe anonymous column ... ;", + "type": "go", + "request": "launch", + "mode": "debug", + "program": "${workspaceFolder}/stackql", + "args": [ + "exec", + "--registry={ \"useEmbedded\": false, \"url\": \"file://${workspaceFolder}/examples/registry\", \"localDocRoot\": \"${workspaceFolder}/examples/registry\", \"verifyConfig\": { \"nopVerify\": true } }", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", + "describe publicapis.api.categories;" + ], + }, + { + "name": "DEBUG BYO anonymous column ... ;", + "type": "go", + "request": "launch", + "mode": "debug", + "program": "${workspaceFolder}/stackql", + "args": [ + "exec", + "--registry={ \"useEmbedded\": false, \"url\": \"file://${workspaceFolder}/examples/registry\", \"localDocRoot\": \"${workspaceFolder}/examples/registry\", \"verifyConfig\": { \"nopVerify\": true } }", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", + "select column_anon as f from publicapis.api.categories where column_anon like 'B%' limit 10;" + ], + }, + { + "name": "DEBUG BYO API ... ;", + "type": "go", + "request": "launch", + "mode": "debug", + "program": "${workspaceFolder}/stackql", + "args": [ + "exec", + "--registry={ \"useEmbedded\": false, \"url\": \"file://${workspaceFolder}/examples/registry\", \"localDocRoot\": \"${workspaceFolder}/examples/registry\", \"verifyConfig\": { \"nopVerify\": true } }", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", + "select API from publicapis.api.apis limit 10;" + ], + }, + // exec /*+ SHOWRESULTS */ publicapis.api.health.get; + { + "name": "DEBUG bool select BYO anon ... ;", + "type": "go", + "request": "launch", + "mode": "debug", + "program": "${workspaceFolder}/stackql", + "args": [ + "exec", + "--registry={ \"useEmbedded\": false, \"url\": \"file://${workspaceFolder}/examples/registry\", \"localDocRoot\": \"${workspaceFolder}/examples/registry\", \"verifyConfig\": { \"nopVerify\": true } }", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", + "select * from (exec /*+ SHOWRESULTS */ publicapis.api.health.get);" + ], + }, + { + "name": "SELECT using table alias... ;", "type": "go", "request": "launch", "mode": "debug", "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--auth={ \"google\": { \"keyfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"keyfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"keyfiletype\": \"api_key\" } }", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "select apps.id from okta.application.apps apps where subdomain = 'dev-79923018-admin';", "-o", "json" @@ -138,7 +220,7 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "insert /*+ AWAIT */ into google.logging.`organizations.locations.buckets`(parent, bucketId) values('projects/lab-kr-network-01/locations/australia-southeast1', 'kr-lab-network-01-logging-bucket-03');", "-o", "json" @@ -153,7 +235,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "select * from google.bigquery.jobs where projectId='lab-kr-network-01';", "-o", "json" @@ -167,7 +249,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--credentialsfilepath=${workspaceFolder}/keys/sa-key.json", "select * from ( exec /*+ SHOWRESULTS */ google.bigquery.jobs.getQueryResults @projectId='lab-kr-network-01', @jobId='bquxjob_19abc6d_17c14bbcb9e' ) ;", "-o", "json" @@ -181,7 +263,7 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--auth={ \"google\": { \"keyfilepath\": \"${workspaceFolder}/keys/sa-key.json\" } }", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" } }", "--cpuprofile=${workspaceFolder}/build/prof1.prof", "select name from (EXEC /*+ SHOWRESULTS */ google.compute.disks.get @disk = 'my-disk-01-indeed', @project = 'lab-kr-network-01', @zone = 'australia-southeast1-a');", "-o", @@ -196,8 +278,7 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/okta-token.txt", - "--keyfiletype=api_key", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "insert into okta.application.apps(subdomain, data__name, data__label, data__signOnMode, data__settings) SELECT 'dev-79923018-admin', 'template_basic_auth', 'some new app again', 'BASIC_AUTH', '{ \"app\": { \"authURL\": \"https://example.com/auth.html\", \"url\": \"https://example.com/bookmark.htm\" } }' ;", "-o", "json" @@ -238,8 +319,7 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/okta-token.txt", - "--keyfiletype=api_key", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "delete from okta.application.apps where appId = '0oa3fvey86qdXch1g5d7' and subdomain = 'dev-79923018-admin';", "-o", "json" @@ -253,9 +333,8 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/okta-token.txt", - "--keyfiletype=api_key", - "exec okta.application.apps.deactivate @appId = '0oa3gvv2cruvhWBXU5d7', @subdomain = 'dev-79923018-admin';", + "--auth={ \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", + "exec okta.application.apps.deactivate @appId = '0oa3pssr5jYavmnNF5d7', @subdomain = 'dev-79923018-admin';", "-o", "json" ], @@ -268,8 +347,7 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/okta-token.txt", - "--keyfiletype=api_key", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "show resources from okta.group;", "-o", "json" @@ -283,7 +361,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", // "exec /*+ some AWAIT */ google.compute.disks.list @zone = 'australia-southeast1-a', /* */ @project = 'lab-kr-network-01';", "EXEC /*+ some AWAIT */ compute.disks.insert @project='lab-kr-network-01', @zone= 'australia-southeast1-a' @@json='{ \"name\": \"test-disk9\", \"sizeGb\": 10 }';", // "select name, region from google.compute.subnetworks where region = 'australia-southeast1' AND /* */ project = 'lab-kr-network-01';", @@ -301,7 +379,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "insert into google.compute.disks(project, zone, data__name) SELECT 'lab-kr-network-01', 'australia-southeast1-a', name || '-newzy2' as name from google.compute.disks where project = 'lab-kr-network-01' and zone = 'australia-southeast1-a' limit 2;", "-o", "json" @@ -315,7 +393,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "SHOW EXTENDED INSERT INTO google.bigquery.datasets;", "-o", "pptext" @@ -329,7 +407,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "show insert into google.compute.instances( project, data__sourceSnapshotId );", "-o", "pptext" @@ -343,7 +421,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "show insert /*+ REQUIRED */ into google.compute.addresses;", "-o", "pptext" @@ -357,7 +435,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "show providers;", "-o", "table" @@ -371,7 +449,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "show resources from google.container;", "-o", "table" @@ -385,7 +463,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "-i=${workspaceFolder}/test/assets/input/show-services-extended-filtered.iql", "-o", "table" @@ -399,7 +477,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "-i=${workspaceFolder}/test/assets/input/insert-compute-network.iql", "-o", "table" @@ -414,7 +492,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "select * from google.container.`projects.aggregated.usableSubnetworks` where parent = 'projects/kr-lab-network-01'", "-o", "json" @@ -428,7 +506,7 @@ "program": "${workspaceFolder}/build/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "select * from google.bigquery.datasets where projectId = 'lab-kr-network-01';", "-o", "json" @@ -443,14 +521,14 @@ "program": "${workspaceFolder}/stackql", "args": [ "exec", - "--keyfilepath=${workspaceFolder}/keys/sa-key.json", + "--auth={ \"publicapis\": { \"type\": \"null_auth\" }, \"google\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/sa-key.json\" }, \"okta\": { \"credentialsfilepath\": \"${workspaceFolder}/keys/okta-token.txt\", \"type\": \"api_key\" } }", "SELECT name FROM google.storage.buckets WHERE project = 'lab-kr-network-01';", "-o", "json" ], }, // ; - // ./stackql --verbose --providerroot=./.stackql --keyfilepath=../keys/sa-key.json exec "select canIpForward from compute.instances WHERE zone = 'australia-southeast1-b' AND project = 'lab-kr-network-01' ;" -o json | jq + // ./stackql --verbose --approot=./.stackql --credentialsfilepath=../keys/sa-key.json exec "select canIpForward from compute.instances WHERE zone = 'australia-southeast1-b' AND project = 'lab-kr-network-01' ;" -o json | jq { // need to edit processId as appropriate "name": "Attach to local process -- eg shell -- amend processId as required", diff --git a/CMakeLists.txt b/CMakeLists.txt index c098455f..66f31d8c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -33,10 +33,42 @@ set(INT_TEST_DB_DEST_FILE "test/db/tmp/python-tests-tmp-db.sqlite") enable_testing() +find_program(Python_EXECUTABLE python3) +find_program(Java_EXECUTABLE java) +find_program(Robot_EXECUTABLE robot) +find_program(Maven_EXECUTABLE mvn) + set(TEST_SCRIPT ${CMAKE_CURRENT_SOURCE_DIR}/test/python/main.py) +set(REG_RW_SCRIPT ${CMAKE_CURRENT_SOURCE_DIR}/test/python/registry-rewrite.py) +set(ROBOT_TEST_DIR_PATH ${CMAKE_CURRENT_SOURCE_DIR}/test/functional) add_custom_target(${TARGET} ALL) + +if(NOT Maven_EXECUTABLE) + message(FATAL_ERROR "Cannot find the mvn executable!") +endif() + +if(NOT Python_EXECUTABLE) + message(FATAL_ERROR "Cannot find the python3 executable!") +endif() + +add_custom_command(TARGET ${TARGET} + PRE_BUILD + DEPENDS ${SRCS} + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMAND mvn org.apache.maven.plugins:maven-dependency-plugin:3.2.0:copy -Dartifact=org.mock-server:mockserver-netty:5.12.0:jar:shaded -DoutputDirectory=${CMAKE_CURRENT_SOURCE_DIR}/test/downloads -DdestFileName=mockserver-netty.jar -DoverWrite=true + COMMENT "maven copy mock server artifact" +) + +add_custom_command(TARGET ${TARGET} + PRE_BUILD + DEPENDS ${SRCS} + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMAND ${Python_EXECUTABLE} ${REG_RW_SCRIPT} + COMMENT "set up dummy regsitry for server simulations" +) + add_custom_command(TARGET ${TARGET} PRE_BUILD DEPENDS ${SRCS} @@ -125,8 +157,6 @@ add_custom_command(TARGET ${TARGET} COMMENT "Building Go executable for ${OS_STR_LINUX}" ) -find_program(Python_EXECUTABLE python3) - if(DEFINED ENV{STACKQL_TEST_LOG_LEVEL}) set(STACKQL_TEST_LOG_LEVEL $ENV{STACKQL_TEST_LOG_LEVEL}) @@ -141,13 +171,20 @@ else() message(STATUS "LIVE_INTEGRATION_TESTS cmake variable is empty, only 'always' tests will be run") endif() -if(NOT Python_EXECUTABLE) - message(FATAL_ERROR "Cannot find the python3 executable!") -endif() add_test(NAME int-tests COMMAND ${Python_EXECUTABLE} ${TEST_SCRIPT} --additionalintegrationtestdir=${LIVE_INTEGRATION_TESTS} --loglevel=${STACKQL_TEST_LOG_LEVEL} ) +if(NOT Java_EXECUTABLE) + message(FATAL_ERROR "Cannot find the java executable!") +endif() +if(NOT Robot_EXECUTABLE) + message(FATAL_ERROR "Cannot find the robot executable!") +endif() +add_test(NAME robot-tests + COMMAND ${Robot_EXECUTABLE} ${ROBOT_TEST_DIR_PATH} +) + add_custom_command(TARGET ${TARGET} POST_BUILD COMMAND ctest --verbose) diff --git a/docs/developer_guide.md b/docs/developer_guide.md index 09a5bb79..dbd73bf0 100644 --- a/docs/developer_guide.md +++ b/docs/developer_guide.md @@ -70,6 +70,8 @@ Building locally or in cloud will automatically: 2. Build the executable. 3. Run integration tests. +[This article](https://medium.com/cbi-engineering/mocking-techniques-for-go-805c10f1676b) gives a nice overview of mocking in golang. + ### gotest Test coverage is sparse. Regressions are mitigated by `gotest` integration testing in the [driver](/internal/stackql/driver/driver_integration_test.go) and [stackql](/stackql/main_integration_test.go) packages. Some testing functionality is supported through convenience functionality inside the [test](/internal/test) packages. @@ -133,7 +135,7 @@ Then, on OSX > 10, you will need to whitelist the executable for execution even Then, run test commands, such as: ``` -~/Downloads/stackql --keyfilepath=$HOME/stackql/stackql-devel/keys/sa-key.json exec "select group_concat(substr(name, 0, 5)) || ' lalala' as cc from google.compute.disks where project = 'lab-kr-network-01' and zone = 'australia-southeast1-b';" -o text +~/Downloads/stackql --credentialsfilepath=$HOME/stackql/stackql-devel/keys/sa-key.json exec "select group_concat(substr(name, 0, 5)) || ' lalala' as cc from google.compute.disks where project = 'lab-kr-network-01' and zone = 'australia-southeast1-b';" -o text ``` ## Notes on vitess @@ -180,5 +182,5 @@ is the guts of query processing. ``` -time ./stackql exec --cpuprofile=./select-disks-improved-05.profile --auth='{ "google": { "keyfilepath": "'${HOME}'/stackql/stackql-devel/keys/sa-key.json" }, "okta": { "keyfilepath": "'${HOME}'/stackql/stackql-devel/keys/okta-token.txt", "keyfiletype": "api_key" } } ' "select name from google.compute.disks where project = 'lab-kr-network-01' and zone = 'australia-southeast1-a';" +time ./stackql exec --cpuprofile=./select-disks-improved-05.profile --auth='{ "google": { "credentialsfilepath": "'${HOME}'/stackql/stackql-devel/keys/sa-key.json" }, "okta": { "credentialsfilepath": "'${HOME}'/stackql/stackql-devel/keys/okta-token.txt", "type": "api_key" } } ' "select name from google.compute.disks where project = 'lab-kr-network-01' and zone = 'australia-southeast1-a';" ``` \ No newline at end of file diff --git a/docs/examples.md b/docs/examples.md index 4d23ac70..4633d395 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -4,9 +4,9 @@ ## Assumptions - `stackql` is in your `${PATH}`. -- Authentication particulars are supplied as a json string in the arg `--auth`. Per provider, you supply a key/val pair. The val iteslf is a json string, optionally specifying `keyfiletype` (defaulted to `serviceaccount`, which represents a google service account key). The val minimally contains either: - - An appropriate key file at the file location `{ "keyfilepath": "/PATH/TO/KEY/FILE" }`. For example, with the google provider, one might use a service account json key. - - An appropriate key plaintext stored in an (exported) environment variable. Eg: `{ "keyenvvar": "OKTA_SECRET_KEY" }`. For example, with the google provider, one might use a service account json key. +- Authentication particulars are supplied as a json string in the arg `--auth`. Per provider, you supply a key/val pair. The val iteslf is a json string, optionally specifying `type` (defaulted to `service_account`, which represents a google service account key). The val minimally contains either: + - An appropriate key file at the file location `{ "credentialsfilepath": "/PATH/TO/KEY/FILE" }`. For example, with the google provider, one might use a service account json key. + - An appropriate key plaintext stored in an (exported) environment variable. Eg: `{ "credentialsenvvar": "OKTA_SECRET_KEY" }`. For example, with the google provider, one might use a service account json key. If using `service account` auth against the `google` provider, then no ancillary information is required. If howevere, you are using another key type / provider, then more runtime information is required, eg: @@ -14,10 +14,9 @@ Google: ```sh -export -OKTA_SECRET_KEY="$(cat ${HOME}/stackql/stackql-devel/keys/okta-token.txt)" +export OKTA_SECRET_KEY="$(cat ${HOME}/stackql/stackql-devel/keys/okta-token.txt)" -AUTH_STR='{ "google": { "keyfilepath": "'${HOME}'/stackql/stackql-devel/keys/sa-key.json" }, "okta": { "keyenvvar": "OKTA_SECRET_KEY", "keyfiletype": "api_key" } }' +export AUTH_STR='{ "google": { "credentialsfilepath": "'${HOME}'/stackql/stackql-devel/keys/sa-key.json", "type": "service_account" }, "okta": { "credentialsenvvar": "OKTA_SECRET_KEY", "type": "api_key" } }' ./stackql shell --auth="${AUTH_STR}" @@ -45,8 +44,8 @@ stackql \ ### SHOW SERVICES ``` -stackql --providerroot=../test/.stackql \ - --configfile=../test/.iqlrc exec \ +stackql --approot=../test/.stackql \ + --configfile=../test/.stackqlrc exec \ "SHOW SERVICES from google ;" ; echo ``` @@ -63,4 +62,10 @@ insert into google.compute.disks(project, zone, data__name) SELECT 'lab-kr-netwo ``` insert into okta.application.apps(subdomain, data__name, data__label, data__signOnMode, data__settings) SELECT 'dev-79923018-admin', 'template_basic_auth', 'some other4 new app', 'BASIC_AUTH', '{ "app": { "authURL": "https://example.com/auth.html", "url": "https://example.com/bookmark.html" } }'; +``` + +### aliased table select + +``` +select * from okta.application.apps; ``` \ No newline at end of file diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..6992f5b8 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,23 @@ + + +## BYO Registry + + +```bash + +PROVIDER_REGISTRY_ROOT_DIR="$(pwd)/../examples/registry" + +REG_STR='{ "url": "file://'${PROVIDER_REGISTRY_ROOT_DIR}'", "localDocRoot": "'${PROVIDER_REGISTRY_ROOT_DIR}'", "useEmbedded": false, "verifyConfig": {"nopVerify": true } }' + + +## All auth required ahead of time at this stage, even for no auth providers +AUTH_STR='{ "publicapis": { "type": "null_auth" } }' + +./stackql --auth="${AUTH_STR}" --registry="${REG_STR}" exec "select API from publicapis.api.apis where API like 'Dog%' limit 10;" + +./stackql --auth="${AUTH_STR}" --registry="${REG_STR}" exec "select API from publicapis.api.random where title = 'Dog';" + +## The single, anonmyous column returned from selecing an array of strings is a core issue to fix separate to this +./stackql --auth="${AUTH_STR}" --registry="${REG_STR}" exec "select * from publicapis.api.categories limit 5;" + +``` \ No newline at end of file diff --git a/examples/empty-registry/.gitignore b/examples/empty-registry/.gitignore new file mode 100644 index 00000000..512e99db --- /dev/null +++ b/examples/empty-registry/.gitignore @@ -0,0 +1,3 @@ +* +!.gitignore +!src \ No newline at end of file diff --git a/examples/empty-registry/src/.gitignore b/examples/empty-registry/src/.gitignore new file mode 100644 index 00000000..c96a04f0 --- /dev/null +++ b/examples/empty-registry/src/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore \ No newline at end of file diff --git a/examples/registry/src/publicapis/v1/provider.yaml b/examples/registry/src/publicapis/v1/provider.yaml new file mode 100644 index 00000000..cd6775a6 --- /dev/null +++ b/examples/registry/src/publicapis/v1/provider.yaml @@ -0,0 +1,16 @@ +id: publicapis +name: publicapis +version: v1 +description: Catalogue of public http APIs. +title: Public APIs +providerServices: + api: + description: Public API + Catalogue of known public APIs. + id: api:v1 + name: api + preferred: true + service: + $ref: publicapis/v1/services/api-v1.yaml + title: API catalogue + version: v1 diff --git a/examples/registry/src/publicapis/v1/services/api-v1.yaml b/examples/registry/src/publicapis/v1/services/api-v1.yaml new file mode 100644 index 00000000..1a489144 --- /dev/null +++ b/examples/registry/src/publicapis/v1/services/api-v1.yaml @@ -0,0 +1,209 @@ +components: + schemas: + Api: + type: object + properties: + API: + type: string + Description: + type: string + Auth: + type: string + HTTPS: + type: string + Cors: + type: boolean + Link: + type: string + ApiList: + type: object + properties: + count: + type: integer + entries: + items: + $ref: '#/components/schemas/Api' + type: array + CategoryList: + type: object + properties: + count: + type: integer + categories: + items: + type: string + type: array + HealthStatus: + type: string + x-stackQL-resources: + apis: + id: publicapis.api.apis + name: apis + title: apis + methods: + list: + operation: + $ref: GET + path: + $ref: /entries + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: entries + random: + id: publicapis.api.random + name: random + title: random + methods: + list: + operation: + $ref: GET + path: + $ref: /random + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: entries + categories: + id: publicapis.api.categories + name: categories + title: categories + methods: + list: + operation: + $ref: GET + path: + $ref: /categories + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: categories + health: + id: publicapis.api.health + name: health + title: health + methods: + get: + operation: + $ref: GET + path: + $ref: /health + response: + mediaType: text/plain + openAPIDocKey: '200' +externalDocs: + description: Find more info here + url: https://api.publicapis.org/ +info: + contact: + url: https://api.publicapis.org/ + x-serviceName: api +openapi: 3.0.1 +paths: + /entries: + get: + description: apis currently present in the repository. + Can be filtered through parameters. + parameters: + - description: 'name of entry (matches via substring - i.e. "at" would return "cat" and "atlas")' + in: query + name: title + schema: + type: string + - description: description of entry (matches via substring) + in: query + name: description + schema: + type: string + - description: auth type of entry (can only be values matching in project or null) + in: query + name: auth + schema: + type: string + - description: return entries that support HTTPS or not + in: query + name: https + schema: + type: boolean + - description: 'CORS support for entry ("yes", "no", or "unknown")' + in: query + name: cors + schema: + type: string + - description: return entries of a specific category + in: query + name: category + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApiList' + description: Success + /random: + get: + description: random selection from apis currently present in the repository. + Can be filtered through parameters. + parameters: + - description: 'name of entry (matches via substring - i.e. "at" would return "cat" and "atlas")' + in: query + name: title + schema: + type: string + - description: description of entry (matches via substring) + in: query + name: description + schema: + type: string + - description: auth type of entry (can only be values matching in project or null) + in: query + name: auth + schema: + type: string + - description: return entries that support HTTPS or not + in: query + name: https + schema: + type: boolean + - description: 'CORS support for entry ("yes", "no", or "unknown")' + in: query + name: cors + schema: + type: string + - description: return entries of a specific category + in: query + name: category + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApiList' + description: Success + /categories: + get: + description: list of categories currently present. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CategoryList' + description: Success + /health: + get: + description: apis currently present in the repository. + Can be filtered through parameters. + responses: + '200': + content: + text/plain: + schema: + $ref: '#/components/schemas/HealthStatus' + description: Success +servers: +- url: https://api.publicapis.org diff --git a/go.mod b/go.mod index 9a46b7b8..c66ccb66 100644 --- a/go.mod +++ b/go.mod @@ -3,16 +3,16 @@ module github.com/stackql/stackql go 1.16 require ( + github.com/bketelsen/crypt v0.0.4 // indirect github.com/coreos/etcd v3.3.13+incompatible // indirect github.com/davecgh/go-spew v1.1.1 // indirect - github.com/fatih/color v1.9.0 + github.com/fatih/color v1.13.0 github.com/getkin/kin-openapi v0.88.0 github.com/ghodss/yaml v1.0.0 github.com/go-delve/delve v1.6.1 // indirect github.com/go-openapi/jsonpointer v0.19.5 github.com/google/go-jsonnet v0.17.0 github.com/magiconair/properties v1.8.5 - github.com/mattn/go-isatty v0.0.13 // indirect github.com/mattn/go-runewidth v0.0.13 // indirect github.com/olekukonko/tablewriter v0.0.0-20180130162743-b8a9be070da4 github.com/peterh/liner v1.2.1 // indirect @@ -20,16 +20,18 @@ require ( github.com/prometheus/common v0.9.1 github.com/prometheus/tsdb v0.7.1 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect + github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect github.com/sirupsen/logrus v1.8.1 - github.com/spf13/cobra v1.2.1 + github.com/spf13/cobra v1.3.0 github.com/spf13/pflag v1.0.5 - github.com/spf13/viper v1.8.1 - github.com/stackql/go-openapistackql v0.0.3 + github.com/spf13/viper v1.10.1 + github.com/stackql/go-openapistackql v0.0.4-alpha46 github.com/stackql/go-sqlite3 v0.0.1-stackqlalpha go.starlark.net v0.0.0-20210602144842-1cdb82c9e17a // indirect golang.org/x/arch v0.0.0-20210502124803-cbf565b21d1e // indirect - golang.org/x/oauth2 v0.0.0-20210402161424-2e8d93401602 - golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c + golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 + golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8 + golang.org/x/sys v0.0.0-20211210111614-af8b64212486 gonum.org/v1/gonum v0.0.0-20190331200053-3d26580ed485 gopkg.in/airbrake/gobrake.v2 v2.0.9 // indirect gopkg.in/gemnasium/logrus-airbrake-hook.v2 v2.1.2 // indirect diff --git a/go.sum b/go.sum index 136d8cf0..b8ebfc6c 100644 --- a/go.sum +++ b/go.sum @@ -20,6 +20,16 @@ cloud.google.com/go v0.78.0/go.mod h1:QjdrLG0uq+YwhjoVOLsS1t7TW8fs36kLs4XO5R5ECH cloud.google.com/go v0.79.0/go.mod h1:3bzgcEeQlzbuEAYu4mrWhKqWjmpprinYgKJLgKHnbb8= cloud.google.com/go v0.81.0 h1:at8Tk2zUz63cLPR0JPWm5vp77pEZmzxEQBEfRKn1VV8= cloud.google.com/go v0.81.0/go.mod h1:mk/AM35KwGk/Nm2YSeZbxXdrNK3KZOYHmLkOqC2V6E0= +cloud.google.com/go v0.83.0/go.mod h1:Z7MJUsANfY0pYPdw0lbnivPx4/vhy/e2FEkSkF7vAVY= +cloud.google.com/go v0.84.0/go.mod h1:RazrYuxIK6Kb7YrzzhPoLmCVzl7Sup4NrbKPg8KHSUM= +cloud.google.com/go v0.87.0/go.mod h1:TpDYlFy7vuLzZMMZ+B6iRiELaY7z/gJPaqbMx6mlWcY= +cloud.google.com/go v0.90.0/go.mod h1:kRX0mNRHe0e2rC6oNakvwQqzyDmg57xJ+SZU1eT2aDQ= +cloud.google.com/go v0.93.3/go.mod h1:8utlLll2EF5XMAV15woO4lSbWQlk8rer9aLOfLh7+YI= +cloud.google.com/go v0.94.1/go.mod h1:qAlAugsXlC+JWO+Bke5vCtc9ONxjQT3drlTTnAplMW4= +cloud.google.com/go v0.97.0/go.mod h1:GF7l59pYBVlXQIBLx3a761cZ41F9bBH3JUlihCt2Udc= +cloud.google.com/go v0.98.0/go.mod h1:ua6Ush4NALrHk5QXDWnjvZHN93OuF0HfuEPq9I1X0cM= +cloud.google.com/go v0.99.0 h1:y/cM2iqGgGi5D5DQZl6D9STN/3dR/Vx5Mp8s752oJTY= +cloud.google.com/go v0.99.0/go.mod h1:w0Xx2nLzqWJPuozYQX+hFfCSI8WioryfRDzkoI/Y2ZA= cloud.google.com/go/bigquery v1.0.1/go.mod h1:i/xbL2UlR5RvWAURpBYZTtm/cXjCha9lbfbpx4poX+o= cloud.google.com/go/bigquery v1.3.0/go.mod h1:PjpwJnslEMmckchkHFfq+HTD2DmtT67aNFKH1/VBDHE= cloud.google.com/go/bigquery v1.4.0/go.mod h1:S8dzgnTigyfTmLBfrtrhyYhwRxG72rYxvftPBK2Dvzc= @@ -29,6 +39,7 @@ cloud.google.com/go/bigquery v1.8.0/go.mod h1:J5hqkt3O0uAFnINi6JXValWIb1v0goeZM7 cloud.google.com/go/datastore v1.0.0/go.mod h1:LXYbyblFSglQ5pkeyhO+Qmw7ukd3C+pD7TKLgZqpHYE= cloud.google.com/go/datastore v1.1.0/go.mod h1:umbIZjpQpHh4hmRpGhH4tLFup+FVzqBi1b3c64qFpCk= cloud.google.com/go/firestore v1.1.0/go.mod h1:ulACoGHTpvq5r8rxGJ4ddJZBZqakUQqClKRT5SZwBmk= +cloud.google.com/go/firestore v1.6.1/go.mod h1:asNXNOzBdyVQmEU+ggO8UPodTkEVFW5Qx+rwHnAz+EY= cloud.google.com/go/pubsub v1.0.1/go.mod h1:R0Gpsv3s54REJCy4fxDixWD93lHJMoZTyQ2kNxGRt3I= cloud.google.com/go/pubsub v1.1.0/go.mod h1:EwwdRX2sKPjnvnqCa270oGRyludottCI76h+R3AArQw= cloud.google.com/go/pubsub v1.2.0/go.mod h1:jhfEVHT8odbXTkndysNHCcx0awwzvfOlguIAii9o8iA= @@ -57,6 +68,7 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= github.com/BurntSushi/xgbutil v0.0.0-20160919175755-f7c97cef3b4e/go.mod h1:uw9h2sd4WWHOPdJ13MQpwK5qYWKYDumDqxWWIknEQ+k= github.com/DataDog/datadog-go v2.2.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ= +github.com/DataDog/datadog-go v3.2.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ= github.com/GeertJohan/go.incremental v1.0.0/go.mod h1:6fAjUhbVuX1KcMD3c8TEgVUqmo4seqhv0i0kdATSkM0= github.com/GeertJohan/go.rice v1.0.0/go.mod h1:eH6gbSOAUv07dQuZVnBmoDP8mgsM1rtixis4Tib9if0= github.com/Masterminds/glide v0.13.2/go.mod h1:STyF5vcenH/rUqTEv+/hBXlSTo7KYwg2oc2f4tzPWic= @@ -83,6 +95,7 @@ github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e/go.mod h1:3U/XgcO3hC github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod h1:Q73ZrmVTwzkszR9V5SSuryQ31EELlFMUz1kKyl939pY= github.com/armon/go-metrics v0.0.0-20190430140413-ec5e00d3c878/go.mod h1:3AMJUQhVx52RsWOnlkpikZr01T/yAVN2gn0861vByNg= +github.com/armon/go-metrics v0.3.10/go.mod h1:4O98XIr/9W0sxpJ8UaYkvjk10Iff7SnFrb4QAOwNTFc= github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= @@ -98,8 +111,10 @@ github.com/blang/semver v3.5.0+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnweb github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk= github.com/buger/jsonparser v0.0.0-20200322175846-f7e751efca13/go.mod h1:tgcrVJ81GPSF0mz+0nu1Xaz0fazGPrmmJfJtxjbHhUQ= github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= +github.com/census-instrumentation/opencensus-proto v0.3.0/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc= github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/cespare/xxhash/v2 v2.1.2/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= @@ -109,6 +124,13 @@ github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDk github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= +github.com/cncf/udpa/go v0.0.0-20210930031921-04548b0d99d4/go.mod h1:6pvJx4me5XPnfI9Z40ddWsdw2W/uZgQLFXToKeRcDiI= +github.com/cncf/xds/go v0.0.0-20210312221358-fbca930ec8ed/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= +github.com/cncf/xds/go v0.0.0-20210805033703-aa0b78936158/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= +github.com/cncf/xds/go v0.0.0-20210922020428-25de7278fc84/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= +github.com/cncf/xds/go v0.0.0-20211001041855-01bcc9b48dfe/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= +github.com/cncf/xds/go v0.0.0-20211011173535-cb28da3451f1/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= +github.com/cncf/xds/go v0.0.0-20211130200136-a8f946100490/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= github.com/cockroachdb/datadriven v0.0.0-20190809214429-80d97fb3cbaa/go.mod h1:zn76sxSg3SzpJ0PPJaLDCu+Bu0Lg3sKTORVIj19EIF8= github.com/codahale/hdrhistogram v0.0.0-20161010025455-3a0bb77429bd/go.mod h1:sE/e/2PUdi/liOCUjSTXgM1o87ZssimdTWN964YiIeI= github.com/codegangsta/cli v1.20.0/go.mod h1:/qJNoX69yVSKu5o4jLyXAENLRyk1uhi7zkbQ3slBdOA= @@ -130,6 +152,7 @@ github.com/corpix/uarand v0.1.1/go.mod h1:SFKZvkcRoLqVRFZ4u25xPmp6m9ktANfbpXZ7SJ github.com/cosiner/argv v0.1.0/go.mod h1:EusR6TucWKX+zFgtdUsKT2Cvg45K5rtpCcWz4hK06d8= github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE= github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/daaku/go.zipexe v1.0.0/go.mod h1:z8IiR6TsVLEYKwXAoE/I+8ys/sDkgTzSL0CLnGVd57E= @@ -153,12 +176,18 @@ github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1m github.com/envoyproxy/go-control-plane v0.9.7/go.mod h1:cwu0lG7PUMfa9snN8LXBig5ynNVH9qI8YYLbd1fK2po= github.com/envoyproxy/go-control-plane v0.9.9-0.20201210154907-fd9021fe5dad/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk= github.com/envoyproxy/go-control-plane v0.9.9-0.20210217033140-668b12f5399d/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk= +github.com/envoyproxy/go-control-plane v0.9.9-0.20210512163311-63b5d3c536b0/go.mod h1:hliV/p42l8fGbc6Y9bQ70uLwIvmJyVE5k4iMKlh8wCQ= +github.com/envoyproxy/go-control-plane v0.9.10-0.20210907150352-cf90f659a021/go.mod h1:AFq3mo9L8Lqqiid3OhADV3RfLJnjiw63cSpi+fDTRC0= +github.com/envoyproxy/go-control-plane v0.10.1/go.mod h1:AY7fTTXNdv/aJ2O5jwpxAPOWUZ7hQAEvzN5Pf27BkQQ= github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= +github.com/envoyproxy/protoc-gen-validate v0.6.2/go.mod h1:2t7qjJNvHPx8IjnBOzl9E9/baC+qXE/TeeyBRzgJDws= github.com/evanphx/json-patch v4.2.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk= github.com/evanphx/json-patch v4.5.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk= github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4= github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= +github.com/fsnotify/fsnotify v1.5.1 h1:mZcQUHVQUQWoPXXtuf9yuEXKudkV2sx1E06UadKWpgI= +github.com/fsnotify/fsnotify v1.5.1/go.mod h1:T3375wBYaZdLLcVNkcVbzGHY7f1l/uK5T5Ai1i3InKU= github.com/getkin/kin-openapi v0.88.0 h1:BjJ2JERWJbYE1o1RGEj/5LmR5qw7ecfl3O3su4ImR+0= github.com/getkin/kin-openapi v0.88.0/go.mod h1:660oXbgy5JFMKreazJaQTw7o+X00qeSyhcnluiMv+Xg= github.com/ghodss/yaml v0.0.0-20150909031657-73d445a93680/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= @@ -235,6 +264,7 @@ github.com/golang/groupcache v0.0.0-20160516000752-02826c3e7903/go.mod h1:cIg4er github.com/golang/groupcache v0.0.0-20190702054246-869f871628b6/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/groupcache v0.0.0-20191227052852-215e87163ea7/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y= @@ -243,6 +273,7 @@ github.com/golang/mock v1.4.1/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4= github.com/golang/mock v1.5.0/go.mod h1:CWnOUgYIOo4TcNZ0wHX3YZCqsaM1I1Jvs6v3mP3KVu8= +github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs= github.com/golang/protobuf v0.0.0-20161109072736-4bd1920723d7/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= @@ -263,6 +294,7 @@ github.com/golang/protobuf v1.5.1/go.mod h1:DopwsBzvsk0Fs44TXzsVbJyPhcCPeIwnvohx github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= +github.com/golang/snappy v0.0.3/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= @@ -276,6 +308,7 @@ github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-dap v0.5.0/go.mod h1:5q8aYQFnHOAZEMP+6vmq25HKYAEwE+LF5yh7JKrrhSQ= github.com/google/go-github/v27 v27.0.4/go.mod h1:/0Gr8pJ55COkmv+S/yPKCczSkUPIM/LnFyubufRNIS0= github.com/google/go-jsonnet v0.17.0 h1:/9NIEfhK1NQRKl3sP2536b2+x5HnZMdql7x3yK/l8JY= @@ -286,6 +319,7 @@ github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/ github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs= github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0= github.com/google/martian/v3 v3.1.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0= +github.com/google/martian/v3 v3.2.1/go.mod h1:oBOf6HBosgwRXnUGWUB05QECsc6uvmMiJ3+6W4l/CUk= github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc= github.com/google/pprof v0.0.0-20190515194954-54271f7e092f/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc= github.com/google/pprof v0.0.0-20191218002539-d4f498aebedc/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= @@ -297,12 +331,17 @@ github.com/google/pprof v0.0.0-20201023163331-3e6fc7fc9c4c/go.mod h1:kpwsk12EmLe github.com/google/pprof v0.0.0-20201203190320-1bf35d6f28c2/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/pprof v0.0.0-20210122040257-d980be63207e/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/pprof v0.0.0-20210226084205-cbba55b83ad5/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= +github.com/google/pprof v0.0.0-20210601050228-01bbb1931b22/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= +github.com/google/pprof v0.0.0-20210609004039-a478d1d731e9/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= +github.com/google/pprof v0.0.0-20210720184732-4bb14d4b1be1/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg= github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk= +github.com/googleapis/gax-go/v2 v2.1.0/go.mod h1:Q3nei7sK6ybPYH7twZdmQpAd1MKb7pfu6SK+H1/DsU0= +github.com/googleapis/gax-go/v2 v2.1.1/go.mod h1:hddJymUZASv3XPyGkUpKj8pPO47Rmb0eJc8R6ouapiM= github.com/googleapis/gnostic v0.0.0-20170729233727-0c5108395e2d/go.mod h1:sJBsCZ4ayReDTBIg8b9dl28c5xFWyhBTVRp3pOg5EKY= github.com/googleapis/gnostic v0.2.0/go.mod h1:sJBsCZ4ayReDTBIg8b9dl28c5xFWyhBTVRp3pOg5EKY= github.com/gophercloud/gophercloud v0.1.0/go.mod h1:vxM41WHh5uqHVBMZHzuwNOHh8XEoIEcSTewFxm1c5g8= @@ -320,14 +359,20 @@ github.com/grpc-ecosystem/grpc-gateway v1.9.5/go.mod h1:vNeuVxBJEsws4ogUvrchl83t github.com/grpc-ecosystem/grpc-gateway v1.16.0/go.mod h1:BDjrQk3hbvj6Nolgz8mAMFbcEtjT1g+wF4CSlocrBnw= github.com/hashicorp/consul/api v1.1.0/go.mod h1:VmuI/Lkw1nC05EYQWNKwWGbkg+FbDBtguAZLlVdkD9Q= github.com/hashicorp/consul/api v1.5.0/go.mod h1:LqwrLNW876eYSuUOo4ZLHBcdKc038txr/IMfbLPATa4= +github.com/hashicorp/consul/api v1.11.0/go.mod h1:XjsvQN+RJGWI2TWy1/kqaE16HrR2J/FWgkYjdZQsX9M= +github.com/hashicorp/consul/api v1.12.0/go.mod h1:6pVBMo0ebnYdt2S3H87XhekM/HHrUoTD2XXb/VrZVy0= github.com/hashicorp/consul/sdk v0.1.1/go.mod h1:VKf9jXwCTEY1QZP2MOLRhb5i/I/ssyNV1vwHyQBF0x8= github.com/hashicorp/consul/sdk v0.5.0/go.mod h1:fY08Y9z5SvJqevyZNy6WWPXiG3KwBPAvlcdx16zZ0fM= +github.com/hashicorp/consul/sdk v0.8.0/go.mod h1:GBvyrGALthsZObzUGsfgHZQDXjg4lOjagTIwIR1vPms= github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= +github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= github.com/hashicorp/go-hclog v0.12.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= +github.com/hashicorp/go-hclog v1.0.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= github.com/hashicorp/go-immutable-radix v1.0.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60= github.com/hashicorp/go-immutable-radix v1.1.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60= +github.com/hashicorp/go-immutable-radix v1.3.1/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60= github.com/hashicorp/go-msgpack v0.5.3/go.mod h1:ahLV/dePpqEmjfWmKiqvPkv/twdG7iPBM1vqhUKIvfM= github.com/hashicorp/go-msgpack v0.5.5/go.mod h1:ahLV/dePpqEmjfWmKiqvPkv/twdG7iPBM1vqhUKIvfM= github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk= @@ -351,13 +396,18 @@ github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= github.com/hashicorp/mdns v1.0.0/go.mod h1:tL+uN++7HEJ6SQLQ2/p+z2pH24WQKWjBPkE0mNTz8vQ= github.com/hashicorp/mdns v1.0.1/go.mod h1:4gW7WsVCke5TE7EPeYliwHlRUyBtfCwuFwuMg2DmyNY= +github.com/hashicorp/mdns v1.0.4/go.mod h1:mtBihi+LeNXGtG8L9dX59gAEa12BDtBQSp4v/YAJqrc= github.com/hashicorp/memberlist v0.1.3/go.mod h1:ajVTdAv/9Im8oMAAj5G31PhhMCZJV2pPBoIllUwCN7I= github.com/hashicorp/memberlist v0.2.0/go.mod h1:MS2lj3INKhZjWNqd3N0m3J+Jxf3DAOnAH9VT3Sh9MUE= github.com/hashicorp/memberlist v0.2.2/go.mod h1:MS2lj3INKhZjWNqd3N0m3J+Jxf3DAOnAH9VT3Sh9MUE= +github.com/hashicorp/memberlist v0.3.0/go.mod h1:MS2lj3INKhZjWNqd3N0m3J+Jxf3DAOnAH9VT3Sh9MUE= github.com/hashicorp/serf v0.8.2/go.mod h1:6hOLApaqBFA1NXqRQAsxw9QxuDEvNxSQRwA/JwenrHc= github.com/hashicorp/serf v0.9.0/go.mod h1:YL0HO+FifKOW2u1ke99DGVu1zhcpZzNwrLIqBC7vbYU= github.com/hashicorp/serf v0.9.2/go.mod h1:UWDWwZeL5cuWDJdl0C6wrvrUwEqtQ4ZKBKKENpqIUyk= +github.com/hashicorp/serf v0.9.5/go.mod h1:UWDWwZeL5cuWDJdl0C6wrvrUwEqtQ4ZKBKKENpqIUyk= +github.com/hashicorp/serf v0.9.6/go.mod h1:TXZNMjZQijwlDvp+r0b63xZ45H7JmCmgg4gpTwn9UV4= github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= +github.com/iancoleman/strcase v0.2.0/go.mod h1:iwCmte+B7n89clKwxIoIXy/HfoL7AsD47ZCWhYzw7ho= github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/icrowley/fake v0.0.0-20180203215853-4178557ae428/go.mod h1:uhpZMVGznybq1itEKXj6RYw9I71qK4kH+OGMjRC4KEo= @@ -374,6 +424,7 @@ github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/u github.com/json-iterator/go v1.1.8/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= github.com/json-iterator/go v1.1.9/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= github.com/json-iterator/go v1.1.11/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk= github.com/jtolds/gls v4.2.1+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= @@ -397,6 +448,7 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/krishicks/yaml-patch v0.0.10/go.mod h1:Sm5TchwZS6sm7RJoyg87tzxm2ZcKzdRE4Q7TjNhPrME= +github.com/lyft/protoc-gen-star v0.5.3/go.mod h1:V0xaHgaf5oCCqmcxYcWiDfTiKsZsRc87/1qhoTACD8w= github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= github.com/magiconair/properties v1.8.1/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= github.com/magiconair/properties v1.8.5 h1:b6kJs+EmPFMYGkow9GiUyCyOvIwYetYJ3fSaWak/Gls= @@ -414,6 +466,8 @@ github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVc github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc= github.com/mattn/go-colorable v0.1.8 h1:c1ghPdyEDarC70ftn0y+A/Ee++9zz8ljHG1b13eJ0s8= github.com/mattn/go-colorable v0.1.8/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc= +github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40= +github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= github.com/mattn/go-ieproxy v0.0.0-20190610004146-91bb50d98149/go.mod h1:31jz6HNzdxOmlERGGEc4v/dMssOfmp2p5bT/okiKFFc= github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4= github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4= @@ -422,6 +476,8 @@ github.com/mattn/go-isatty v0.0.10/go.mod h1:qgIWMr58cqv1PHHyhnkY9lrL7etaEgOFcME github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= github.com/mattn/go-isatty v0.0.13 h1:qdl+GuBjcsKKDco5BsxPJlId98mSWNKqYA+Co0SC1yA= github.com/mattn/go-isatty v0.0.13/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= +github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y= +github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= github.com/mattn/go-runewidth v0.0.3/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU= @@ -429,6 +485,7 @@ github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg= github.com/miekg/dns v1.1.26/go.mod h1:bPDLeHnStXmXAq1m/Ch/hvfNHr14JKNPMBo3VZKjuso= +github.com/miekg/dns v1.1.41/go.mod h1:p6aan82bvRIyn+zDIv9xYNUpwa73JcSh9BKwknJysuI= github.com/minio/minio-go v0.0.0-20190131015406-c8a261de75c1/go.mod h1:vuvdOZLJuf5HmJAJrKV64MmozrSsk+or0PB5dzdfspg= github.com/mitchellh/cli v1.0.0/go.mod h1:hNIlj7HEI86fIcpObd7a0FcrxTWetlwJDGcceTlRvqc= github.com/mitchellh/cli v1.1.0/go.mod h1:xcISNoH86gajksDmfB23e/pu+B+GeFRMYmoHXxx3xhI= @@ -445,11 +502,14 @@ github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh github.com/mitchellh/mapstructure v1.2.3/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/mitchellh/mapstructure v1.4.1 h1:CpVNEelQCZBooIPDn+AR3NpivK/TIKU8bDxdASFVQag= github.com/mitchellh/mapstructure v1.4.1/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= +github.com/mitchellh/mapstructure v1.4.3 h1:OVowDSCllw/YjdLkam3/sm7wEtOy59d8ndGgCcyj8cs= +github.com/mitchellh/mapstructure v1.4.3/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= github.com/modern-go/reflect2 v0.0.0-20180320133207-05fbef0ca5da/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= github.com/munnerz/goautoneg v0.0.0-20120707110453-a547fc61f48d/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= @@ -475,6 +535,8 @@ github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtP github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic= github.com/pelletier/go-toml v1.9.3 h1:zeC5b1GviRUyKYd6OJPvBU/mcVDVoL1OhT17FCt5dSQ= github.com/pelletier/go-toml v1.9.3/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c= +github.com/pelletier/go-toml v1.9.4 h1:tjENF6MfZAg8e4ZmZTeWaWiT2vXtsoO6+iuOjFhECwM= +github.com/pelletier/go-toml v1.9.4/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c= github.com/peterbourgon/diskv v2.0.1+incompatible/go.mod h1:uqqh8zWWbv1HBMNONnaR/tNboyR3/BZd58JJSHlUSCU= github.com/peterh/liner v0.0.0-20170317030525-88609521dc4b/go.mod h1:xIteQHvHuaLYG9IFj6mSxM0fCKrs34IrEQUhOYuGPHc= github.com/peterh/liner v1.2.1/go.mod h1:CRroGNssyjTd/qIG2FyxByd2S8JEAZXBl4qUrZf8GS0= @@ -492,6 +554,7 @@ github.com/pquerna/cachecontrol v0.0.0-20171018203845-0dec1b30a021/go.mod h1:prY github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= github.com/prometheus/client_golang v0.9.2/go.mod h1:OsXs2jCmiKlQ1lTBmv21f2mNfw4xf/QclQDMrYNZzcM= github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo= +github.com/prometheus/client_golang v1.4.0/go.mod h1:e9GMxYsXl05ICDXkRhurwBS4Q3OK1iX/F2sw+iXX5zU= github.com/prometheus/client_golang v1.4.1/go.mod h1:e9GMxYsXl05ICDXkRhurwBS4Q3OK1iX/F2sw+iXX5zU= github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= @@ -517,6 +580,8 @@ github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQD github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts= github.com/ryanuber/columnize v2.1.0+incompatible/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts= +github.com/sagikazarmark/crypt v0.3.0/go.mod h1:uD/D+6UF4SrIR1uGEv7bBNkNqLGqUr43MRiaGWX1Nig= +github.com/sagikazarmark/crypt v0.4.0/go.mod h1:ALv2SRj7GxYV4HO9elxH9nS6M9gW+xDNxqmyJ6RfDFM= github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0= github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc= github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= @@ -535,16 +600,21 @@ github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4k github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA= github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ= github.com/spf13/afero v1.2.2/go.mod h1:9ZxEEn6pIJ8Rxe320qSDBk6AsU0r9pR7Q4OcevTdifk= +github.com/spf13/afero v1.3.3/go.mod h1:5KUK8ByomD5Ti5Artl0RtHeI5pTF7MIDuXL3yY520V4= github.com/spf13/afero v1.6.0 h1:xoax2sJ2DT8S8xA2paPFjDCScCNeWsg75VG0DLRreiY= github.com/spf13/afero v1.6.0/go.mod h1:Ai8FlHk4v/PARR026UzYexafAt9roJ7LcLMAmO6Z93I= github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= github.com/spf13/cast v1.3.1 h1:nFm6S0SMdyzrzcmThSipiEubIDy8WEXKNZ0UOgiRpng= github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= +github.com/spf13/cast v1.4.1 h1:s0hze+J0196ZfEMTs80N7UlFt0BDuQ7Q+JDnHiMWKdA= +github.com/spf13/cast v1.4.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= github.com/spf13/cobra v0.0.0-20170417170307-b6cb39589372/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ= github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ= github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU= github.com/spf13/cobra v1.2.1 h1:+KmjbUw1hriSNMF55oPrkZcb27aECyrj8V2ytv7kWDw= github.com/spf13/cobra v1.2.1/go.mod h1:ExllRjgxM/piMAM+3tAZvg8fsklGAf3tPfi+i8t68Nk= +github.com/spf13/cobra v1.3.0 h1:R7cSvGu+Vv+qX0gW5R/85dx2kmmJT5z5NM8ifdYjdn0= +github.com/spf13/cobra v1.3.0/go.mod h1:BrRVncBjOJa/eUcVVm9CE+oC6as8k+VYr4NY7WCi9V4= github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo= github.com/spf13/jwalterweatherman v1.1.0 h1:ue6voC5bR5F8YxI5S67j9i582FU4Qvo2bmqnqMYADFk= github.com/spf13/jwalterweatherman v1.1.0/go.mod h1:aNWZUN0dPAAO/Ljvb5BEdw96iTZ0EXowPYD95IqWIGo= @@ -557,6 +627,9 @@ github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s= github.com/spf13/viper v1.8.1 h1:Kq1fyeebqsBfbjZj4EL7gj2IO0mMaiyjYUWcUsl2O44= github.com/spf13/viper v1.8.1/go.mod h1:o0Pch8wJ9BVSWGQMbra6iw0oQ5oktSIBaujf1rJH9Ns= +github.com/spf13/viper v1.10.0/go.mod h1:SoyBPwAtKDzypXNDFKN5kzH7ppppbGZtls1UpIy5AsM= +github.com/spf13/viper v1.10.1 h1:nuJZuYpG7gTj/XqiUwg8bA0cp1+M2mC3J4g5luUYBKk= +github.com/spf13/viper v1.10.1/go.mod h1:IGlFPqhNAPKRxohIzWpI5QEy4kuI7tcl5WvR+8qy1rU= github.com/stackql/color v1.10.1-0.20210418074258-4aa529ee76ed h1:4izL1eXwRTPJW9Uv4FILuosDTqmtMcyxM2qyST1G4ZU= github.com/stackql/color v1.10.1-0.20210418074258-4aa529ee76ed/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM= github.com/stackql/go-openapistackql v0.0.3-alpha8 h1:zxrnK5D7mQWVwO3sxtcHisI4D6Btk+dBKUS/y6auWMA= @@ -565,12 +638,102 @@ github.com/stackql/go-openapistackql v0.0.3 h1:/Nc7R8B6Jl/eP/eNqngbMUx8MYfxx0eII github.com/stackql/go-openapistackql v0.0.3/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= github.com/stackql/go-openapistackql v0.0.4-alpha1 h1:8WUV4eo+vTJSynCOXSZUFfLW4KBF5pCAgP+kxWVrGA8= github.com/stackql/go-openapistackql v0.0.4-alpha1/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= +github.com/stackql/go-openapistackql v0.0.4-alpha11 h1:2LHOcSE6YQEgidctdnmbafxCxp6ILQx8RZmkpblQm7k= +github.com/stackql/go-openapistackql v0.0.4-alpha11/go.mod h1:jfdlMy4/ZYcJQjlf8IrRL1hbNmGTDcFt6Ri9pnsjDho= +github.com/stackql/go-openapistackql v0.0.4-alpha12 h1:z0t69MqF92HEs92vDDrbDQqjBRt9DZfQfD6At1Kgrlk= +github.com/stackql/go-openapistackql v0.0.4-alpha12/go.mod h1:jfdlMy4/ZYcJQjlf8IrRL1hbNmGTDcFt6Ri9pnsjDho= +github.com/stackql/go-openapistackql v0.0.4-alpha13 h1:s/UpsuUeTm8ZIoeoO6ch0OGG4q3y0X++7mijr0BCBpc= +github.com/stackql/go-openapistackql v0.0.4-alpha13/go.mod h1:jfdlMy4/ZYcJQjlf8IrRL1hbNmGTDcFt6Ri9pnsjDho= +github.com/stackql/go-openapistackql v0.0.4-alpha15 h1:z8J8+T5rLxSWlQQ+j0PbAhN/26GfkztdILTCEfU9z5k= +github.com/stackql/go-openapistackql v0.0.4-alpha15/go.mod h1:3kT49HH3LjXqFjKOaRf5Mam2m6MBYKjd3NWIZctpiU8= +github.com/stackql/go-openapistackql v0.0.4-alpha16 h1:emg29m7DP2fmVHfUIHt9gEcFQpPt/zVg6qEohXf253Q= +github.com/stackql/go-openapistackql v0.0.4-alpha16/go.mod h1:3kT49HH3LjXqFjKOaRf5Mam2m6MBYKjd3NWIZctpiU8= +github.com/stackql/go-openapistackql v0.0.4-alpha17 h1:PCX+f1mZMG1QhFFulCzPKbrv0Ogv4coo6had0yBXnpE= +github.com/stackql/go-openapistackql v0.0.4-alpha17/go.mod h1:lH3Mh4AYySeAy3B+RHMTie0kC5Mvwr+EchuVkDrnmNE= +github.com/stackql/go-openapistackql v0.0.4-alpha18 h1:GZ0veYkEIxy7p386Il0kdTbHRDVXx24EpGf+vAqe8Cc= +github.com/stackql/go-openapistackql v0.0.4-alpha18/go.mod h1:lH3Mh4AYySeAy3B+RHMTie0kC5Mvwr+EchuVkDrnmNE= +github.com/stackql/go-openapistackql v0.0.4-alpha19 h1:0fi1FW2mfxSi7iUlnVRsmrYS/qpEHNxVu8ssexjka48= +github.com/stackql/go-openapistackql v0.0.4-alpha19/go.mod h1:lH3Mh4AYySeAy3B+RHMTie0kC5Mvwr+EchuVkDrnmNE= +github.com/stackql/go-openapistackql v0.0.4-alpha2 h1:vO/7rzQDbtQrKhp9fVMtod9uIIvTQL0sY+zGp4Xqua8= +github.com/stackql/go-openapistackql v0.0.4-alpha2/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= +github.com/stackql/go-openapistackql v0.0.4-alpha20 h1:VYMixaZmoYe0+a4zMCYnZwg6ZPI8/ixw0iR6DW9WFvs= +github.com/stackql/go-openapistackql v0.0.4-alpha20/go.mod h1:lH3Mh4AYySeAy3B+RHMTie0kC5Mvwr+EchuVkDrnmNE= +github.com/stackql/go-openapistackql v0.0.4-alpha21 h1:ay6p1TNjkroYNY40a88GfCVQ2e5llXAy9i3faqKgnaM= +github.com/stackql/go-openapistackql v0.0.4-alpha21/go.mod h1:lH3Mh4AYySeAy3B+RHMTie0kC5Mvwr+EchuVkDrnmNE= +github.com/stackql/go-openapistackql v0.0.4-alpha22 h1:vPLoPuqBq72FxrhIYsrtLbRP2Pr+mgH/Ax7h74/9fbc= +github.com/stackql/go-openapistackql v0.0.4-alpha22/go.mod h1:p7kcmCxpCfocrsr/n4A1aLqBzDfAcsGNyYB4fvtD1BI= +github.com/stackql/go-openapistackql v0.0.4-alpha24 h1:KbSAsI9YNkGONHluBthlcGIsIiGWsbpKsyDa29gGd+g= +github.com/stackql/go-openapistackql v0.0.4-alpha24/go.mod h1:UaxRyaRj/k1cHwoAg+aKLcFDyQBF0y4KlVIjmeRZnvI= +github.com/stackql/go-openapistackql v0.0.4-alpha25 h1:y/tiR3LRtmeMIXLeHv0NooHfTEHltn0Qb/FCKFA2CXA= +github.com/stackql/go-openapistackql v0.0.4-alpha25/go.mod h1:UaxRyaRj/k1cHwoAg+aKLcFDyQBF0y4KlVIjmeRZnvI= +github.com/stackql/go-openapistackql v0.0.4-alpha26 h1:IuWbSmd/P9fW396blBPSO5uXwj8UH8ykshiOBb4a/AM= +github.com/stackql/go-openapistackql v0.0.4-alpha26/go.mod h1:ICUFCjepJUy4cF4LGCAZ8prFTazCRARxq5a+yX/RPfE= +github.com/stackql/go-openapistackql v0.0.4-alpha27 h1:zN4mGmojkdamyM2WnVb2RpRgsAI40L8jotwncVSKMGc= +github.com/stackql/go-openapistackql v0.0.4-alpha27/go.mod h1:ICUFCjepJUy4cF4LGCAZ8prFTazCRARxq5a+yX/RPfE= +github.com/stackql/go-openapistackql v0.0.4-alpha28 h1:O76B33CjP4xwYtKUNBpTYO3qqPX5JUfL6IhXgbuOYLQ= +github.com/stackql/go-openapistackql v0.0.4-alpha28/go.mod h1:mmJHovEqN1tjt4YjXdBS6OfB2cFFhleVhHr6vXzrCas= +github.com/stackql/go-openapistackql v0.0.4-alpha29 h1:u7ZJ18luCi5WJRB4Y911Xi7PGDgVknkfcEOyNv4Uo2M= +github.com/stackql/go-openapistackql v0.0.4-alpha29/go.mod h1:yqI4zH413RP2Yk6zWSv/fXs8PgU2ZDuR5iVBWpQdUyU= +github.com/stackql/go-openapistackql v0.0.4-alpha3 h1:WPXh4EqhXXmV74KUx5N+6/Vp/ZDkAAd4BBaZM696A64= +github.com/stackql/go-openapistackql v0.0.4-alpha3/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= +github.com/stackql/go-openapistackql v0.0.4-alpha30 h1:irR9k/IcQzVMVOsjVVywgm8XCnHiq53h9Rjo4NetXQM= +github.com/stackql/go-openapistackql v0.0.4-alpha30/go.mod h1:yqI4zH413RP2Yk6zWSv/fXs8PgU2ZDuR5iVBWpQdUyU= +github.com/stackql/go-openapistackql v0.0.4-alpha31 h1:hwAxv81j+XG1uvzju0B/GyeRTKCLxEv5+yWeuFnkvKQ= +github.com/stackql/go-openapistackql v0.0.4-alpha31/go.mod h1:yqI4zH413RP2Yk6zWSv/fXs8PgU2ZDuR5iVBWpQdUyU= +github.com/stackql/go-openapistackql v0.0.4-alpha33 h1:HIksovaHlGQIulFmsKFUgBkBPU8/i5SmD6TDp4JwIdY= +github.com/stackql/go-openapistackql v0.0.4-alpha33/go.mod h1:yqI4zH413RP2Yk6zWSv/fXs8PgU2ZDuR5iVBWpQdUyU= +github.com/stackql/go-openapistackql v0.0.4-alpha34 h1:DvAbj08yKLL40xf8iSYHRjzm0Fxesx++crz+y3taHrw= +github.com/stackql/go-openapistackql v0.0.4-alpha34/go.mod h1:yqI4zH413RP2Yk6zWSv/fXs8PgU2ZDuR5iVBWpQdUyU= +github.com/stackql/go-openapistackql v0.0.4-alpha35 h1:4E4J/MwyJvP4V/ar3LF3WDV1OOx3e+hSOjcviBlo4YQ= +github.com/stackql/go-openapistackql v0.0.4-alpha35/go.mod h1:yqI4zH413RP2Yk6zWSv/fXs8PgU2ZDuR5iVBWpQdUyU= +github.com/stackql/go-openapistackql v0.0.4-alpha36 h1:uE/vC4scXeFN+MeHvq4mK5g10zKRuqQgQG+3kTjdtlw= +github.com/stackql/go-openapistackql v0.0.4-alpha36/go.mod h1:yqI4zH413RP2Yk6zWSv/fXs8PgU2ZDuR5iVBWpQdUyU= +github.com/stackql/go-openapistackql v0.0.4-alpha37 h1:8h+PoWgD9bBhBZg+geeJnNTWj79buIVps7uAqgkGIP0= +github.com/stackql/go-openapistackql v0.0.4-alpha37/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha38 h1:O8XnBf/yx+1tOtGmF9cEShYpa77wD4T/XZgxu12T2EA= +github.com/stackql/go-openapistackql v0.0.4-alpha38/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha39 h1:0Ipz7v6UNakcB2Eb7vNFklmPk1YCIgi2eu7M7XlyWW4= +github.com/stackql/go-openapistackql v0.0.4-alpha39/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha4 h1:vc8kPXM/zw6PnJ6j/iz5DWgYhjGaw0x4e5oF/o6DUvE= +github.com/stackql/go-openapistackql v0.0.4-alpha4/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= +github.com/stackql/go-openapistackql v0.0.4-alpha40 h1:zxE1EYuYP6/kdN7tyNyyco5Zvj5lotzmwscCAlvzI4g= +github.com/stackql/go-openapistackql v0.0.4-alpha40/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha41 h1:jPeqiaKW0VToAcbKZZPsxmfZSgvUBBx7K3z99+++CNI= +github.com/stackql/go-openapistackql v0.0.4-alpha41/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha42 h1:jSfHOvqmsbYVmkH+smk9vJ+cks1oAdyjx4Sk8KPQ4eQ= +github.com/stackql/go-openapistackql v0.0.4-alpha42/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha43 h1:0r9wRdY5jAAfUcShLfkvz8QJ9KzrZ0NRaW28x+kmLII= +github.com/stackql/go-openapistackql v0.0.4-alpha43/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha44 h1:NnCTq5JL6JTDUDD+ucXsJXdLcCTiCgWHv8Ou6r9qDo4= +github.com/stackql/go-openapistackql v0.0.4-alpha44/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha45 h1:UGRO8B047qL5MLoizXTCOVPKpyk9U0rkPb4ozIykdNU= +github.com/stackql/go-openapistackql v0.0.4-alpha45/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha46 h1:yYtpySoZ1M1rIKG98Jv8uMaPdlrQm9wumoomru9xLL0= +github.com/stackql/go-openapistackql v0.0.4-alpha46/go.mod h1:DSVjQrASsDMSP+9r+iE3rKFWJ+4XDkIRF8pjUjsaNC4= +github.com/stackql/go-openapistackql v0.0.4-alpha5 h1:ZT/T8e4ERsyrCVBIKBkwhaMaq7yjcXbhwiTKA3Apu4c= +github.com/stackql/go-openapistackql v0.0.4-alpha5/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= +github.com/stackql/go-openapistackql v0.0.4-alpha6 h1:F3Ip66LkMZrzRdhmb33rwvcMFNvmZvDCZjOfkhzte6k= +github.com/stackql/go-openapistackql v0.0.4-alpha6/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= +github.com/stackql/go-openapistackql v0.0.4-alpha7 h1:H9KIwvLpyw+uPR9ehc2yIOdJiarldXnNMnIDnm7lf7g= +github.com/stackql/go-openapistackql v0.0.4-alpha7/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= +github.com/stackql/go-openapistackql v0.0.4-alpha8 h1:u351D3DRAUJ1mjNW3Mu5gmDRnuPuVAgIDjcuGeR0E3o= +github.com/stackql/go-openapistackql v0.0.4-alpha8/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= +github.com/stackql/go-openapistackql v0.0.4-alpha9 h1:NYhl7QKGsgmhZUKM0LeT1j/ZSu7bESJkGtDOyu5KfSY= +github.com/stackql/go-openapistackql v0.0.4-alpha9/go.mod h1:ficis807+HOpLcS6fLpPbsYY5pOsn9RuPeP0UlOqNQQ= github.com/stackql/go-spew v1.1.3-alpha24 h1:yNmgWU+OKU8SvlQ0umiQWWgWS6C5U1GuRMlYfQgbmJA= github.com/stackql/go-spew v1.1.3-alpha24/go.mod h1:o2MPqg2ee1PN4SxAh9zQSJJmKKFJjpro9pejdK7dXWk= github.com/stackql/go-sqlite3 v0.0.1-stackqlalpha h1:Ze9rqvLF76IuI42KqffAmBBQcIgInQrGJQkmTcoVRTI= github.com/stackql/go-sqlite3 v0.0.1-stackqlalpha/go.mod h1:JHMGM3Hu7TcW8NBiJMFSBCHaUkhm1VjGZD5/uDaUDf4= github.com/stackql/readline v0.0.0-20210418072316-6e4ad520d2b4 h1:p7Vwt6eUueKQY8rGb7S86URa6Tf9bwlTmJoL0EcTLYg= github.com/stackql/readline v0.0.0-20210418072316-6e4ad520d2b4/go.mod h1:GsQot9cgbH0B1/8pwoQKJ3KAAXaE+8BjFD2RvJOGs1Y= +github.com/stackql/stackql-provider-registry v0.0.1-alpha11/go.mod h1:D0WFWa7HOXS+PQAmvN0Nm1E6dMdUkUFtAzRH8cXxg88= +github.com/stackql/stackql-provider-registry v0.0.1-alpha12/go.mod h1:D0WFWa7HOXS+PQAmvN0Nm1E6dMdUkUFtAzRH8cXxg88= +github.com/stackql/stackql-provider-registry v0.0.1-alpha8 h1:MLOIn55Zr6VmmKz1GV5SVH+zLcHC0B8VSWJzrtFX4MM= +github.com/stackql/stackql-provider-registry v0.0.1-alpha8/go.mod h1:2Zw/OeEvFlDijJKcac26T3PjuouXfHOhgLXm+Sgg2/A= +github.com/stackql/stackql-provider-registry v0.0.1-alpha901 h1:a0YjF0hVo+VTmCgp6catjaxzwEytxFtA/EPG8qxRtYU= +github.com/stackql/stackql-provider-registry v0.0.1-alpha901/go.mod h1:D0WFWa7HOXS+PQAmvN0Nm1E6dMdUkUFtAzRH8cXxg88= +github.com/stackql/stackql-provider-registry v0.0.1-alpha903 h1:S0W2zFWXxiBYiXxGkNnLHyRG8MpC9CwCxqhdsz4ZCiA= +github.com/stackql/stackql-provider-registry v0.0.1-alpha903/go.mod h1:D0WFWa7HOXS+PQAmvN0Nm1E6dMdUkUFtAzRH8cXxg88= github.com/stackql/vitess v0.0.9-alpha7 h1:CBCPeyH0yzz2cgswVjWYDqdZi6mE6kZZQ268kWopFwQ= github.com/stackql/vitess v0.0.9-alpha7/go.mod h1:4M5NhkFYCF10+U3LS4owUYY2GsUt+7t1kN9Rv5UVc9A= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= @@ -613,8 +776,11 @@ github.com/z-division/go-zookeeper v0.0.0-20190128072838-6d7457066b9b/go.mod h1: go.etcd.io/bbolt v1.3.3/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU= go.etcd.io/etcd v0.0.0-20191023171146-3cf2f69b5738/go.mod h1:dnLIgRNXwCJa5e+c6mIZCrds/GIG4ncV9HhK5PX7jPg= go.etcd.io/etcd/api/v3 v3.5.0/go.mod h1:cbVKeC6lCfl7j/8jBhAK6aIYO9XOjdptoxU/nLQcPvs= +go.etcd.io/etcd/api/v3 v3.5.1/go.mod h1:cbVKeC6lCfl7j/8jBhAK6aIYO9XOjdptoxU/nLQcPvs= go.etcd.io/etcd/client/pkg/v3 v3.5.0/go.mod h1:IJHfcCEKxYu1Os13ZdwCwIUTUVGYTSAM3YSwc9/Ac1g= +go.etcd.io/etcd/client/pkg/v3 v3.5.1/go.mod h1:IJHfcCEKxYu1Os13ZdwCwIUTUVGYTSAM3YSwc9/Ac1g= go.etcd.io/etcd/client/v2 v2.305.0/go.mod h1:h9puh54ZTgAKtEbut2oe9P4L/oqKCVB6xsXlzd7alYQ= +go.etcd.io/etcd/client/v2 v2.305.1/go.mod h1:pMEacxZW7o8pg4CrFE7pquyCJJzZvkvdD2RibOCCCGs= go.mongodb.org/mongo-driver v1.0.3/go.mod h1:u7ryQJ+DOzQmeO7zB6MHyr8jkEQvC8vH7qLUO4lqsUM= go.mongodb.org/mongo-driver v1.1.1/go.mod h1:u7ryQJ+DOzQmeO7zB6MHyr8jkEQvC8vH7qLUO4lqsUM= go.mongodb.org/mongo-driver v1.1.2/go.mod h1:u7ryQJ+DOzQmeO7zB6MHyr8jkEQvC8vH7qLUO4lqsUM= @@ -625,6 +791,7 @@ go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.5/go.mod h1:5pWMHQbX5EPX2/62yrJeAkowc+lfs/XD7Uxpq3pI6kk= go.opencensus.io v0.23.0/go.mod h1:XItmlyltB5F7CS4xOC1DcqMoFqwtC6OG2xF7mCv7P7E= +go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI= go.starlark.net v0.0.0-20200821142938-949cc6f4b097/go.mod h1:f0znQkUKRrkk36XxWbGjMqQM8wGv/xHBVE2qc3B5oFU= go.starlark.net v0.0.0-20210602144842-1cdb82c9e17a/go.mod h1:t3mmBBPzAVvK0L0n1drDmrQsJ8FoIx4INCqVMTr/Zo0= go.uber.org/atomic v1.3.2/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= @@ -652,7 +819,10 @@ golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392/go.mod h1:/lpIB1dKB+9EgE3 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20191206172530-e9b2fee46413/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200220183623-bac4c82f6975/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9 h1:psW17arqaxU48Z5kZ0CQnkZWQJsqcURM6tKiBApRjXI= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 h1:HWj/xjIHfjYU5nVXpTM0s39J9CbLn7Cc5a7IC5rwsMQ= +golang.org/x/crypto v0.0.0-20210817164053-32db794688a5/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190125153040-c74c464bbbf2/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= @@ -690,6 +860,7 @@ golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.5.0/go.mod h1:5OXOZSfqPIIbmVBIIKWRFfZjPR0E5r58TLhUjH0a2Ro= golang.org/x/net v0.0.0-20170114055629-f2499483f923/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -740,6 +911,10 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v golang.org/x/net v0.0.0-20210316092652-d523dce5a7f4/go.mod h1:RBQZq4jEuRlivfhVLdyRGr576XBO4/greRjx4P4O3yc= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 h1:4nGaVu0QrbjT/AK2PRLuQfQuh6DJve+pELhqTdAj3x0= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= +golang.org/x/net v0.0.0-20210410081132-afb366fc7cd1/go.mod h1:9tjilg8BloeKEkVJvy7fQ90B1CfIiPueXVOjqfkSzI8= +golang.org/x/net v0.0.0-20210503060351-7fd8e65b6420/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d h1:LO7XpTYMwTqxjLcGWPijK3vRXg1aWdlNOVOHRq45d7c= +golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= @@ -753,6 +928,13 @@ golang.org/x/oauth2 v0.0.0-20210220000619-9bb904979d93/go.mod h1:KelEdhl1UZF7XfJ golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210402161424-2e8d93401602 h1:0Ja1LBD+yisY6RWM/BH7TJVXWsSjs2VwBSmvSX4HdBc= golang.org/x/oauth2 v0.0.0-20210402161424-2e8d93401602/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= +golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= +golang.org/x/oauth2 v0.0.0-20210628180205-a41e5a781914/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= +golang.org/x/oauth2 v0.0.0-20210805134026-6f1e6394065a/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= +golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= +golang.org/x/oauth2 v0.0.0-20211005180243-6b3c2da341f1/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= +golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8 h1:RerP+noqYHUQ8CMRcPlC2nvTa4dcBIjegkuWdcUDuqg= +golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -819,14 +1001,30 @@ golang.org/x/sys v0.0.0-20201201145000-ef89a241ccb3/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210104204734-6f8348627aad/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210220050731-9a76102bfb43/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210303074136-134d130e1a04/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210305230114-8fe3ee5dd75b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210315160823-c6e025ad8005/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210514084401-e8d321eab015/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210603125802-9665404d3644/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210616094352-59db8d763f22/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210816183151-1e6c022a8912/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210908233432-aa78b53d3365/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211007075335-d3039528d8ac/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211124211545-fe61309f8881/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211205182925-97ca703d548d/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211210111614-af8b64212486 h1:5hpz5aRr+W1erYCL5JRhSUBJRph7l9XkNveoExlrKYk= +golang.org/x/sys v0.0.0-20211210111614-af8b64212486/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.0.0-20160726164857-2910a502d2bf/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= @@ -837,6 +1035,9 @@ golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.5 h1:i6eZZ+zk0SOf0xgBpEpPD18qWcJda6q1sxt3S0kzyUQ= golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= @@ -904,6 +1105,9 @@ golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/tools v0.1.3/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -934,12 +1138,25 @@ google.golang.org/api v0.40.0/go.mod h1:fYKFpnQN0DsDSKRVRcQSDQNtqWPfM9i+zNPxepjR google.golang.org/api v0.41.0/go.mod h1:RkxM5lITDfTzmyKFPt+wGrCJbVfniCr2ool8kTBzRTU= google.golang.org/api v0.43.0/go.mod h1:nQsDGjRXMo4lvh5hP0TKqF244gqhGcr/YSIykhUk/94= google.golang.org/api v0.44.0/go.mod h1:EBOGZqzyhtvMDoxwS97ctnh0zUmYY6CxqXsc1AvkYD8= +google.golang.org/api v0.47.0/go.mod h1:Wbvgpq1HddcWVtzsVLyfLp8lDg6AA241LmgIL59tHXo= +google.golang.org/api v0.48.0/go.mod h1:71Pr1vy+TAZRPkPs/xlCf5SsU8WjuAWv1Pfjbtukyy4= +google.golang.org/api v0.50.0/go.mod h1:4bNT5pAuq5ji4SRZm+5QIkjny9JAyVD/3gaSihNefaw= +google.golang.org/api v0.51.0/go.mod h1:t4HdrdoNgyN5cbEfm7Lum0lcLDLiise1F8qDKX00sOU= +google.golang.org/api v0.54.0/go.mod h1:7C4bFFOvVDGXjfDTAsgGwDgAxRDeQ4X8NvUedIt6z3k= +google.golang.org/api v0.55.0/go.mod h1:38yMfeP1kfjsl8isn0tliTjIb1rJXcQi4UXlbqivdVE= +google.golang.org/api v0.56.0/go.mod h1:38yMfeP1kfjsl8isn0tliTjIb1rJXcQi4UXlbqivdVE= +google.golang.org/api v0.57.0/go.mod h1:dVPlbZyBo2/OjBpmvNdpn2GRm6rPy75jyU7bmhdrMgI= +google.golang.org/api v0.59.0/go.mod h1:sT2boj7M9YJxZzgeZqXogmhfmRWDtPzT31xkieUbuZU= +google.golang.org/api v0.61.0/go.mod h1:xQRti5UdCmoCEqFxcz93fTl338AVqDgyaDRuOZ3hg9I= +google.golang.org/api v0.62.0/go.mod h1:dKmwPCydfsad4qCH08MSdgWjfHOyfpd4VtDGgRFdavw= +google.golang.org/api v0.63.0/go.mod h1:gs4ij2ffTRXwuzzgJl/56BdwJaA194ijkfn++9tDuPo= google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= google.golang.org/appengine v1.5.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= google.golang.org/appengine v1.6.1/go.mod h1:i06prIuMbXzDqacNJfV5OdTW448YApPu5ww/cMBSeb0= google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= google.golang.org/appengine v1.6.6/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= +google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c= google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= google.golang.org/genproto v0.0.0-20190307195333-5fe7a883aa19/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= @@ -983,8 +1200,31 @@ google.golang.org/genproto v0.0.0-20210303154014-9728d6b83eeb/go.mod h1:FWY/as6D google.golang.org/genproto v0.0.0-20210310155132-4ce2db91004e/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20210402141018-6c239bbf2bb1/go.mod h1:9lPAdzaEmUacj36I+k7YKbEc5CXzPIeORRgDAUOu28A= +google.golang.org/genproto v0.0.0-20210513213006-bf773b8c8384/go.mod h1:P3QM42oQyzQSnHPnZ/vqoCdDmzH28fzWByN9asMeM8A= google.golang.org/genproto v0.0.0-20210602131652-f16073e35f0c h1:wtujag7C+4D6KMoulW9YauvK2lgdvCMS260jsqqBXr0= google.golang.org/genproto v0.0.0-20210602131652-f16073e35f0c/go.mod h1:UODoCrxHCcBojKKwX1terBiRUaqAsFqJiF615XL43r0= +google.golang.org/genproto v0.0.0-20210604141403-392c879c8b08/go.mod h1:UODoCrxHCcBojKKwX1terBiRUaqAsFqJiF615XL43r0= +google.golang.org/genproto v0.0.0-20210608205507-b6d2f5bf0d7d/go.mod h1:UODoCrxHCcBojKKwX1terBiRUaqAsFqJiF615XL43r0= +google.golang.org/genproto v0.0.0-20210624195500-8bfb893ecb84/go.mod h1:SzzZ/N+nwJDaO1kznhnlzqS8ocJICar6hYhVyhi++24= +google.golang.org/genproto v0.0.0-20210713002101-d411969a0d9a/go.mod h1:AxrInvYm1dci+enl5hChSFPOmmUF1+uAa/UsgNRWd7k= +google.golang.org/genproto v0.0.0-20210716133855-ce7ef5c701ea/go.mod h1:AxrInvYm1dci+enl5hChSFPOmmUF1+uAa/UsgNRWd7k= +google.golang.org/genproto v0.0.0-20210728212813-7823e685a01f/go.mod h1:ob2IJxKrgPT52GcgX759i1sleT07tiKowYBGbczaW48= +google.golang.org/genproto v0.0.0-20210805201207-89edb61ffb67/go.mod h1:ob2IJxKrgPT52GcgX759i1sleT07tiKowYBGbczaW48= +google.golang.org/genproto v0.0.0-20210813162853-db860fec028c/go.mod h1:cFeNkxwySK631ADgubI+/XFU/xp8FD5KIVV4rj8UC5w= +google.golang.org/genproto v0.0.0-20210821163610-241b8fcbd6c8/go.mod h1:eFjDcFEctNawg4eG61bRv87N7iHBWyVhJu7u1kqDUXY= +google.golang.org/genproto v0.0.0-20210828152312-66f60bf46e71/go.mod h1:eFjDcFEctNawg4eG61bRv87N7iHBWyVhJu7u1kqDUXY= +google.golang.org/genproto v0.0.0-20210831024726-fe130286e0e2/go.mod h1:eFjDcFEctNawg4eG61bRv87N7iHBWyVhJu7u1kqDUXY= +google.golang.org/genproto v0.0.0-20210903162649-d08c68adba83/go.mod h1:eFjDcFEctNawg4eG61bRv87N7iHBWyVhJu7u1kqDUXY= +google.golang.org/genproto v0.0.0-20210909211513-a8c4777a87af/go.mod h1:eFjDcFEctNawg4eG61bRv87N7iHBWyVhJu7u1kqDUXY= +google.golang.org/genproto v0.0.0-20210924002016-3dee208752a0/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= +google.golang.org/genproto v0.0.0-20211008145708-270636b82663/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= +google.golang.org/genproto v0.0.0-20211028162531-8db9c33dc351/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= +google.golang.org/genproto v0.0.0-20211118181313-81c1377c94b1/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= +google.golang.org/genproto v0.0.0-20211129164237-f09f9a12af12/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= +google.golang.org/genproto v0.0.0-20211203200212-54befc351ae9/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= +google.golang.org/genproto v0.0.0-20211206160659-862468c7d6e0/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= +google.golang.org/genproto v0.0.0-20211208223120-3a66f561d7aa h1:I0YcKz0I7OAhddo7ya8kMnvprhcWM045PmkBdMO9zN0= +google.golang.org/genproto v0.0.0-20211208223120-3a66f561d7aa/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= google.golang.org/grpc v1.20.1/go.mod h1:10oTOabMzJvdu6/UiuZezV6QK5dSlG84ov/aaiqXj38= google.golang.org/grpc v1.21.1/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM= @@ -1006,8 +1246,18 @@ google.golang.org/grpc v1.34.0/go.mod h1:WotjhfgOW/POjDeRt8vscBtXq+2VjORFy659qA5 google.golang.org/grpc v1.35.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= google.golang.org/grpc v1.36.1/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= +google.golang.org/grpc v1.37.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM= +google.golang.org/grpc v1.37.1/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM= google.golang.org/grpc v1.38.0 h1:/9BgsAsa5nWe26HqOlvlgJnqBuktYOLCgjCPqsa56W0= google.golang.org/grpc v1.38.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM= +google.golang.org/grpc v1.39.0/go.mod h1:PImNr+rS9TWYb2O4/emRugxiyHZ5JyHW5F+RPnDzfrE= +google.golang.org/grpc v1.39.1/go.mod h1:PImNr+rS9TWYb2O4/emRugxiyHZ5JyHW5F+RPnDzfrE= +google.golang.org/grpc v1.40.0/go.mod h1:ogyxbiOoUXAkP+4+xa6PZSE9DZgIHtSpzjDTB9KAK34= +google.golang.org/grpc v1.40.1/go.mod h1:ogyxbiOoUXAkP+4+xa6PZSE9DZgIHtSpzjDTB9KAK34= +google.golang.org/grpc v1.42.0/go.mod h1:k+4IHHFw41K8+bbowsex27ge2rCb65oeWqe4jJ590SU= +google.golang.org/grpc v1.43.0 h1:Eeu7bZtDZ2DpRCsLhUlcrLnvYaMK1Gz86a+hMVvELmM= +google.golang.org/grpc v1.43.0/go.mod h1:k+4IHHFw41K8+bbowsex27ge2rCb65oeWqe4jJ590SU= +google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0/go.mod h1:6Kw0yEErY5E/yWrBtf03jp27GLLJujG4z/JK95pnjjw= google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= @@ -1021,6 +1271,8 @@ google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlba google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk= google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= +google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= gopkg.in/DataDog/dd-trace-go.v1 v1.17.0/go.mod h1:DVp8HmDh8PuTu2Z0fVVlBsyWaC++fzwVCaGWylTe3tg= gopkg.in/airbrake/gobrake.v2 v2.0.9/go.mod h1:/h5ZAUhDkGaJfjzjKLSjv6zCL6O0LLBxU4K+aSYdM/U= gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= @@ -1037,6 +1289,8 @@ gopkg.in/ini.v1 v1.41.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/ini.v1 v1.51.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/ini.v1 v1.62.0 h1:duBzk771uxoUuOlyRLkHsygud9+5lrlGjdFBb4mSKDU= gopkg.in/ini.v1 v1.62.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= +gopkg.in/ini.v1 v1.66.2 h1:XfR1dOYubytKy4Shzc2LHrrGhU0lDCfDGG1yLPmpgsI= +gopkg.in/ini.v1 v1.66.2/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/ldap.v2 v2.5.0/go.mod h1:oI0cpe/D7HRtBQl8aTg+ZmzFUAvu4lsv3eLXMLGFxWk= gopkg.in/natefinch/lumberjack.v2 v2.0.0/go.mod h1:l0ndWWf7gzL7RNwBG7wST/UCcT4T24xpD6X8LsfU/+k= gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= diff --git a/internal/pkg/pgp/pgp.go b/internal/pkg/pgp/pgp.go new file mode 100644 index 00000000..4fe02d6c --- /dev/null +++ b/internal/pkg/pgp/pgp.go @@ -0,0 +1,98 @@ +package pgp + +import ( + "bytes" + "encoding/hex" + "errors" + "fmt" + "io/ioutil" + "os" + + "golang.org/x/crypto/openpgp/packet" +) + +// gpg --export YOURKEYID --export-options export-minimal,no-export-attributes | hexdump /dev/stdin -v -e '/1 "%02X"' +var publicKeyHex string = "99[VERY LONG HEX STRING]B6" + +func notMain() { + if len(os.Args) != 3 { + fmt.Println("Usage: " + os.Args[0] + " ") + return + } + + err := checkSig(os.Args[1], os.Args[2]) + + if err != nil { + fmt.Println("Invalid signature : ") + fmt.Println(err) + } else { + fmt.Println("Valid signature") + } +} + +func checkSig(fileName string, sigFileName string) error { + // First, get the content of the file we have signed + fileContent, err := ioutil.ReadFile(fileName) + if err != nil { + return err + } + + // Get a Reader for the signature file + sigFile, err := os.Open(sigFileName) + if err != nil { + return err + } + + defer func() { + if err := sigFile.Close(); err != nil { + panic(err) + } + }() + + // Read the signature file + pack, err := packet.Read(sigFile) + if err != nil { + return err + } + + // Was it really a signature file ? If yes, get the Signature + signature, ok := pack.(*packet.Signature) + if !ok { + return errors.New(os.Args[2] + " is not a valid signature file.") + } + + // For convenience, we have the key in hexadecimal, convert it to binary + publicKeyBin, err := hex.DecodeString(publicKeyHex) + if err != nil { + return err + } + + // Read the key + pack, err = packet.Read(bytes.NewReader(publicKeyBin)) + if err != nil { + return err + } + + // Was it really a public key file ? If yes, get the PublicKey + publicKey, ok := pack.(*packet.PublicKey) + if !ok { + return errors.New("Invalid public key.") + } + + // Get the hash method used for the signature + hash := signature.Hash.New() + + // Hash the content of the file (if the file is big, that's where you have to change the code to avoid getting the whole file in memory, by reading and writting in small chunks) + _, err = hash.Write(fileContent) + if err != nil { + return err + } + + // Check the signature + err = publicKey.VerifySignature(hash, signature) + if err != nil { + return err + } + + return nil +} diff --git a/internal/stackql/asyncmonitor/asyncmonitor.go b/internal/stackql/asyncmonitor/asyncmonitor.go index 6226f7b6..bc981122 100644 --- a/internal/stackql/asyncmonitor/asyncmonitor.go +++ b/internal/stackql/asyncmonitor/asyncmonitor.go @@ -90,12 +90,11 @@ func NewAsyncMonitor(prov provider.IProvider) (IAsyncMonitor, error) { func newGoogleAsyncMonitor(prov provider.IProvider, version string) (IAsyncMonitor, error) { switch version { - case "v1": + default: return &DefaultGoogleAsyncMonitor{ provider: prov, }, nil } - return nil, fmt.Errorf("async operation monitor for google, api version = '%s' currently not supported", version) } type DefaultGoogleAsyncMonitor struct { @@ -105,10 +104,9 @@ type DefaultGoogleAsyncMonitor struct { func (gm *DefaultGoogleAsyncMonitor) GetMonitorPrimitive(heirarchy *taxonomy.HeirarchyObjects, precursor primitive.IPrimitive, initialCtx primitive.IPrimitiveCtx, comments sqlparser.CommentDirectives) (primitive.IPrimitive, error) { switch strings.ToLower(heirarchy.Provider.GetVersion()) { - case "v1": + default: return gm.getV1Monitor(heirarchy, precursor, initialCtx, comments) } - return nil, fmt.Errorf("monitor primitive unavailable for service = '%s', resource = '%s', method = '%s'", heirarchy.HeirarchyIds.ServiceStr, heirarchy.HeirarchyIds.ResourceStr, heirarchy.HeirarchyIds.MethodStr) } func getOperationDescriptor(body map[string]interface{}) string { diff --git a/internal/stackql/cache/marshall.go b/internal/stackql/cache/marshall.go deleted file mode 100644 index d86d34cc..00000000 --- a/internal/stackql/cache/marshall.go +++ /dev/null @@ -1,92 +0,0 @@ -package cache - -import ( - "fmt" - - "encoding/json" - - "github.com/stackql/go-openapistackql/openapistackql" - - "gopkg.in/yaml.v2" -) - -type IMarshaller interface { - Unmarshal(item *Item) error - Marshal(item *Item) error - GetKey() string -} - -func GetMarshaller(key string) (IMarshaller, error) { - switch key { - case DefaultMarshallerKey: - return &DefaultMarshaller{}, nil - case RootMarshallerKey: - return &RootDiscoveryMarshaller{}, nil - case ServiceMarshallerKey: - return &ServiceDiscoveryMarshaller{}, nil - } - return nil, fmt.Errorf("cannot find apt marshaller") -} - -type DefaultMarshaller struct{} - -func (dm *DefaultMarshaller) Unmarshal(item *Item) error { - return json.Unmarshal(item.RawValue, &item.Value) -} - -func (dm *DefaultMarshaller) Marshal(item *Item) error { - return nil -} - -func (dm *DefaultMarshaller) GetKey() string { - return DefaultMarshallerKey -} - -type RootDiscoveryMarshaller struct{} - -func (dm *RootDiscoveryMarshaller) Unmarshal(item *Item) error { - var err error - var blob map[string]*openapistackql.Service - err = json.Unmarshal(item.RawValue, &blob) - if err != nil { - return err - } - item.Value = blob - return err -} - -func (dm *RootDiscoveryMarshaller) Marshal(item *Item) error { - var err error - prov, ok := item.Value.(openapistackql.Provider) - if !ok { - return fmt.Errorf("cannot marshal root discovery doc of type = %T", prov) - } - item.RawValue, err = yaml.Marshal(&prov) - return err -} - -func (dm *RootDiscoveryMarshaller) GetKey() string { - return RootMarshallerKey -} - -type ServiceDiscoveryMarshaller struct{} - -func (dm *ServiceDiscoveryMarshaller) Unmarshal(item *Item) error { - blob, err := openapistackql.LoadServiceDocFromBytes(item.RawValue) - item.Value = blob - return err -} - -func (dm *ServiceDiscoveryMarshaller) Marshal(item *Item) error { - value, ok := item.Value.(*openapistackql.Service) - if !ok { - return fmt.Errorf("Cannot Marshal cache object of type: %T", item.Value) - } - bytes, err := value.MarshalJSON() - item.RawValue = (json.RawMessage)(bytes) - return err -} - -func (dm *ServiceDiscoveryMarshaller) GetKey() string { - return ServiceMarshallerKey -} diff --git a/internal/stackql/cache/ttl_kv_cache.go b/internal/stackql/cache/ttl_kv_cache.go deleted file mode 100644 index c7431a2b..00000000 --- a/internal/stackql/cache/ttl_kv_cache.go +++ /dev/null @@ -1,185 +0,0 @@ -package cache - -import ( - "encoding/json" - "fmt" - "path" - "sync" - "time" - - "github.com/stackql/stackql/internal/stackql/constants" - "github.com/stackql/stackql/internal/stackql/dto" - "github.com/stackql/stackql/internal/stackql/sqlengine" - - log "github.com/sirupsen/logrus" -) - -const ( - DefaultMarshallerKey string = "default_marshaller" - RootMarshallerKey string = "root_marshaller" - ServiceMarshallerKey string = "service_marshaller" -) - -type IKeyValCache interface { - Len() int - Get(string, IMarshaller) interface{} - Put(string, interface{}, IMarshaller) -} - -type Item struct { - Value interface{} `json:"-"` - RawValue json.RawMessage `json:"raw_value"` - LastAccess int64 - Marshaller IMarshaller `json:"-"` - MarshallerKey string - Tablespace string - TablespaceID int -} - -type TTLMap struct { - m map[string]*Item - l sync.Mutex - cacheName string - cacheFileSuffix string - runtimeCtx dto.RuntimeCtx - dbEngine sqlengine.SQLEngine -} - -func (m *TTLMap) persistToFile() { - - for k, v := range m.m { - err := v.Marshaller.Marshal(v) - if err != nil { - log.Infoln(fmt.Sprintf("persist to file Marshal error = %s", err.Error())) - continue - } - log.Debugln(fmt.Sprintf("persisting to cache: k = '%s', v = %v", k, v)) - blob, jsonErr := json.Marshal(v) - if jsonErr != nil { - log.Infoln(fmt.Sprintf("persist to file final Marshal error = %s", jsonErr.Error())) - continue - } - log.Debugln(fmt.Sprintf("persisting to cache: k = '%s', blob = %s", k, string(blob))) - m.dbEngine.CacheStorePut(k, blob, v.Tablespace, v.TablespaceID) - } -} - -func (m *TTLMap) getCacheDir(relativePath string) string { - return path.Join(m.runtimeCtx.ProviderRootPath, relativePath) -} - -func sanitisePath(p string) string { - return p -} - -func (m *TTLMap) getCacheFileName() string { - if m.cacheFileSuffix == "" { - return m.cacheName - } - return m.cacheName + "." + m.cacheFileSuffix -} - -func (m *TTLMap) restoreFromFile() error { - im := make(map[string]*Item) - cachedKVs, err := m.dbEngine.CacheStoreGetAll() - log.Infoln(fmt.Sprintf("len(cachedKVs) = %v", len(cachedKVs))) - if err != nil { - return err - } else { - for _, kv := range cachedKVs { - val := &Item{} - jErr := json.Unmarshal(kv.V, val) - if jErr != nil { - return fmt.Errorf("error unmarshaling kv raw, key = '%s': %v", kv.K, jErr) - } - marshaller, e := GetMarshaller(val.MarshallerKey) - if e != nil { - return e - } - val.Marshaller = marshaller - jsonErr := val.Marshaller.Unmarshal(val) - if jsonErr != nil { - return fmt.Errorf("error unmarshaling kv item, key = '%s': %v", kv.K, jsonErr) - } - im[kv.K] = val - } - } - m.m = im - return nil -} - -func NewTTLMap( - dbEngine sqlengine.SQLEngine, - runtimeCtx dto.RuntimeCtx, - cacheName string, - initSize int, - maxTTL int, - marshaller IMarshaller) IKeyValCache { - log.Infoln(fmt.Sprintf("cache op: created new cache")) - m := &TTLMap{ - m: make(map[string]*Item, initSize), - cacheName: cacheName, - cacheFileSuffix: constants.JsonStr, - runtimeCtx: runtimeCtx, - dbEngine: dbEngine, - } - restorErr := m.restoreFromFile() - if restorErr != nil { - log.Infoln(restorErr.Error()) - } - go func() { - for now := range time.Tick(time.Second) { - m.l.Lock() - for k, v := range m.m { - if (maxTTL > 0) && ((now.Unix() - v.LastAccess) > int64(maxTTL)) { - delete(m.m, k) - log.Infoln(fmt.Sprintf("cache op: deleted %s", k)) - } - } - m.l.Unlock() - } - }() - return m -} - -func (m *TTLMap) Len() int { - return len(m.m) -} - -func (m *TTLMap) Put(k string, v interface{}, marshaller IMarshaller) { - if v == nil { - log.Infoln("attempting to add nil to cache") - return - } - m.l.Lock() - defer m.l.Unlock() - log.Debugln(fmt.Sprintf("TTLMap.Put() called for k = %v, v = %v", k, v)) - it := &Item{ - Value: v, - Marshaller: marshaller, - MarshallerKey: marshaller.GetKey(), - } - m.m[k] = it - log.Infoln(fmt.Sprintf("cache op: added %s", k)) - it.LastAccess = time.Now().Unix() - log.Infoln(fmt.Sprintf("type of interface for Put = %T", v)) - m.persistToFile() -} - -func (m *TTLMap) Get(k string, marshaller IMarshaller) (v interface{}) { - m.l.Lock() - i := 0 - for keyStr, v := range m.m { - log.Infoln(fmt.Sprintf("key[%d] = %s, vale type = %T", i, keyStr, v)) - i++ - } - if it, ok := m.m[k]; ok { - v = it.Value - log.Infoln(fmt.Sprintf("cache op: succeeded in retrieving %s", k)) - it.LastAccess = time.Now().Unix() - } else { - log.Infoln(fmt.Sprintf("cache op: failed to retrieve %s", k)) - } - m.l.Unlock() - return -} diff --git a/internal/stackql/cmd/exec.go b/internal/stackql/cmd/exec.go index ae184c91..9f47af85 100644 --- a/internal/stackql/cmd/exec.go +++ b/internal/stackql/cmd/exec.go @@ -39,11 +39,11 @@ input file. For example: stackql exec \ "select id, name from compute.instances where project = 'stackql-demo' and zone = 'australia-southeast1-a'" \ ---keyfilepath /mnt/c/tmp/stackql-demo.json --output csv +--credentialsfilepath /mnt/c/tmp/stackql-demo.json --output csv -stackql exec -i iqlscripts/listinstances.iql --keyfilepath /mnt/c/tmp/stackql-demo.json --output json +stackql exec -i iqlscripts/listinstances.iql --credentialsfilepath /mnt/c/tmp/stackql-demo.json --output json -stackql exec -i iqlscripts/create-disk.iql --keyfilepath /mnt/c/tmp/stackql-demo.json +stackql exec -i iqlscripts/create-disk.iql --credentialsfilepath /mnt/c/tmp/stackql-demo.json `, Run: func(cmd *cobra.Command, args []string) { diff --git a/internal/stackql/cmd/registry.go b/internal/stackql/cmd/registry.go new file mode 100644 index 00000000..d1e595bd --- /dev/null +++ b/internal/stackql/cmd/registry.go @@ -0,0 +1,63 @@ +/* +Copyright © 2019 stackql info@stackql.io + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ +package cmd + +import ( + "github.com/spf13/cobra" + + "github.com/stackql/stackql/internal/stackql/handler" + "github.com/stackql/stackql/internal/stackql/iqlerror" +) + +// execCmd represents the exec command +var registryCmd = &cobra.Command{ + Use: "registry", + Short: "Interaction with the provider registry, as configured at initialisation time. Usage: stackql registry {subcommand} [{arg}]", + Long: ` + Interaction with the provider registry, as configured at initialisation time. Usage: stackql registry {subcommand} + Currently supported subcommands: + - pull {provider} {version} + + `, + Run: func(cmd *cobra.Command, args []string) { + usagemsg := cmd.Long + "\n\n" + cmd.UsageString() + if len(args) < 1 { + iqlerror.PrintErrorAndExitOneWithMessage(usagemsg) + } + reg, err := handler.GetRegistry(runtimeCtx) + if err != nil { + iqlerror.PrintErrorAndExitOneWithMessage(err.Error()) + } + if len(args) == 0 { + iqlerror.PrintErrorAndExitOneWithMessage(usagemsg) + } + subCommand := args[0] + switch subCommand { + case "pull": + if len(args) != 3 { + iqlerror.PrintErrorAndExitOneWithMessage(usagemsg) + } + providerName := args[1] + providerVersion := args[2] + err := reg.PullAndPersistProviderArchive(providerName, providerVersion) + if err != nil { + iqlerror.PrintErrorAndExitOneWithMessage(err.Error()) + } + return + } + iqlerror.PrintErrorAndExitOneWithMessage(usagemsg) + }, +} diff --git a/internal/stackql/cmd/root.go b/internal/stackql/cmd/root.go index d7f35e25..643746ba 100644 --- a/internal/stackql/cmd/root.go +++ b/internal/stackql/cmd/root.go @@ -45,6 +45,10 @@ var ( BuildPlatform string = "" ) +const ( + defaultRegistryUrlString string = "https://cdn.statically.io/gh/stackql/stackql-provider-registry/intial-devel/providers" +) + var SemVersion string = fmt.Sprintf("%s.%s.%s", BuildMajorVersion, BuildMinorVersion, BuildPatchVersion) var ( @@ -93,11 +97,14 @@ func init() { rootCmd.PersistentFlags().IntVar(&runtimeCtx.APIRequestTimeout, dto.APIRequestTimeoutKey, 45, "API request timeout in seconds, 0 for no timeout.") rootCmd.PersistentFlags().StringVar(&runtimeCtx.ColorScheme, dto.ColorSchemeKey, config.GetDefaultColorScheme(), fmt.Sprintf("Color scheme, must be one of {'%s', '%s', '%s'}", dto.DarkColorScheme, dto.LightColorScheme, dto.NullColorScheme)) + rootCmd.PersistentFlags().StringVar(&runtimeCtx.CABundle, dto.CABundleKey, "", fmt.Sprintf("Path to CA bundle, if not specified then system defaults used.")) + rootCmd.PersistentFlags().BoolVar(&runtimeCtx.AllowInsecure, dto.AllowInsecureKey, false, "allow insecure cert trust (not recommended)") rootCmd.PersistentFlags().StringVar(&runtimeCtx.ConfigFilePath, dto.ConfigFilePathKey, config.GetDefaultConfigFilePath(), fmt.Sprintf("Config file full path; defaults to current dir")) - rootCmd.PersistentFlags().StringVar(&runtimeCtx.ProviderRootPath, dto.ProviderRootPathKey, config.GetDefaultProviderCacheRoot(), fmt.Sprintf("Config and cache root path")) - rootCmd.PersistentFlags().Uint32Var(&runtimeCtx.ProviderRootPathMode, dto.ProviderRootPathModeKey, config.GetDefaultProviderCacheDirFileMode(), fmt.Sprintf("Config and cache file mode")) + rootCmd.PersistentFlags().StringVar(&runtimeCtx.ApplicationFilesRootPath, dto.ApplicationFilesRootPathKey, config.GetDefaultApplicationFilesRoot(), fmt.Sprintf("Application config and cache root path")) + rootCmd.PersistentFlags().Uint32Var(&runtimeCtx.ApplicationFilesRootPathMode, dto.ApplicationFilesRootPathModeKey, config.GetDefaultProviderCacheDirFileMode(), fmt.Sprintf("Application config and cache file mode")) rootCmd.PersistentFlags().StringVar(&runtimeCtx.ViperCfgFileName, dto.ViperCfgFileNameKey, config.GetDefaultViperConfigFileName(), fmt.Sprintf("Config filename")) - rootCmd.PersistentFlags().StringVar(&runtimeCtx.AuthRaw, dto.AuthCtxKey, "", `auth contexts keyvals in json form, eg: '{ "google": { "keyfilepath": "/path/to/google/sevice/account/key.json", "keyfiletype": "serviceaccount" }, "okta": { "keyenvvar": "OKTA_SECRET_KEY", "keyfiletype": "api_key" } }'`) + rootCmd.PersistentFlags().StringVar(&runtimeCtx.AuthRaw, dto.AuthCtxKey, "", `auth contexts keyvals in json form, eg: '{ "google": { "credentialsfilepath": "/path/to/google/sevice/account/key.json", "type": "service_account" }, "okta": { "credentialsenvvar": "OKTA_SECRET_KEY", "type": "api_key" } }'`) + rootCmd.PersistentFlags().StringVar(&runtimeCtx.RegistryRaw, dto.RegistryRawKey, fmt.Sprintf(`{ "useEmbedded": true, "url": "%s", "localDocRoot": "%s" }`, defaultRegistryUrlString, runtimeCtx.ApplicationFilesRootPath), fmt.Sprintf(`openapi registry context keyvals in json form, eg: '{ "url": "%s" }'.`, defaultRegistryUrlString)) rootCmd.PersistentFlags().StringVar(&runtimeCtx.DbEngine, dto.DbEngineKey, config.GetDefaultDbEngine(), fmt.Sprintf("DB engine id")) rootCmd.PersistentFlags().StringVar(&runtimeCtx.DbFilePath, dto.DbFilePathKey, config.GetDefaultDbFilePath(), fmt.Sprintf("DB persistence filename")) rootCmd.PersistentFlags().IntVar(&runtimeCtx.DbGenerationId, dto.DbGenerationIdKey, txncounter.GetNextGenerationId(), fmt.Sprintf("DB generation id")) @@ -109,7 +116,7 @@ func init() { rootCmd.PersistentFlags().StringVar(&runtimeCtx.HTTPProxyPassword, dto.HTTPProxyPasswordKey, "", "http proxy password") rootCmd.PersistentFlags().StringVar(&runtimeCtx.HTTPProxyUser, dto.HTTPProxyUserKey, "", "http proxy user") rootCmd.PersistentFlags().StringVar(&runtimeCtx.DbInitFilePath, dto.DbInitFilePathKey, config.GetDefaultDbInitFilePath(), fmt.Sprintf("DB init file path")) - rootCmd.PersistentFlags().StringVar(&runtimeCtx.ProviderStr, dto.ProviderStrKey, config.GetGoogleProviderString(), fmt.Sprintf(`stackql provider`)) + rootCmd.PersistentFlags().StringVar(&runtimeCtx.ProviderStr, dto.ProviderStrKey, "", fmt.Sprintf(`stackql provider`)) rootCmd.PersistentFlags().BoolVar(&runtimeCtx.WorkOffline, dto.WorkOfflineKey, false, "Work offline, using cached data") rootCmd.PersistentFlags().BoolVarP(&runtimeCtx.VerboseFlag, dto.VerboseFlagKey, "v", false, "Verbose flag") rootCmd.PersistentFlags().BoolVar(&runtimeCtx.DryRunFlag, dto.DryRunFlagKey, false, "dryrun flag; preprocessor only will run and output returned") @@ -141,6 +148,7 @@ func init() { rootCmd.CompletionOptions.DisableDefaultCmd = true rootCmd.AddCommand(execCmd) rootCmd.AddCommand(shellCmd) + rootCmd.AddCommand(registryCmd) // rootCmd.AddCommand(srvCmd) } @@ -171,15 +179,14 @@ func initConfig() { mergeConfigFromFile(&runtimeCtx, *rootCmd.PersistentFlags()) setLogLevel() - config.CreateDirIfNotExists(runtimeCtx.ProviderRootPath, os.FileMode(runtimeCtx.ProviderRootPathMode)) - config.CreateDirIfNotExists(path.Join(runtimeCtx.ProviderRootPath, runtimeCtx.ProviderStr), os.FileMode(runtimeCtx.ProviderRootPathMode)) - config.CreateDirIfNotExists(config.GetReadlineDirPath(runtimeCtx), os.FileMode(runtimeCtx.ProviderRootPathMode)) + config.CreateDirIfNotExists(runtimeCtx.ApplicationFilesRootPath, os.FileMode(runtimeCtx.ApplicationFilesRootPathMode)) + config.CreateDirIfNotExists(path.Join(runtimeCtx.ApplicationFilesRootPath, runtimeCtx.ProviderStr), os.FileMode(runtimeCtx.ApplicationFilesRootPathMode)) + config.CreateDirIfNotExists(config.GetReadlineDirPath(runtimeCtx), os.FileMode(runtimeCtx.ApplicationFilesRootPathMode)) if runtimeCtx.Reinit { os.Remove(runtimeCtx.DbFilePath) } - viper.SetConfigFile(path.Join(runtimeCtx.ProviderRootPath, runtimeCtx.ViperCfgFileName)) - viper.AddConfigPath(runtimeCtx.ProviderRootPath) - log.Infof("ProviderRootPath = %s, ViperCfgFileName = %s", runtimeCtx.ProviderRootPath, runtimeCtx.ViperCfgFileName) + viper.SetConfigFile(path.Join(runtimeCtx.ApplicationFilesRootPath, runtimeCtx.ViperCfgFileName)) + viper.AddConfigPath(runtimeCtx.ApplicationFilesRootPath) viper.AutomaticEnv() // read in environment variables that match diff --git a/internal/stackql/cmd/shell.go b/internal/stackql/cmd/shell.go index 10a026fb..ac8274e8 100644 --- a/internal/stackql/cmd/shell.go +++ b/internal/stackql/cmd/shell.go @@ -76,7 +76,7 @@ func getShellPRompt(authCtx *dto.AuthCtx, cd *color.ColorDriver) string { return cd.ShellColorPrint("stackql >>") } -func getIntroAuthMsg(authCtx *dto.AuthCtx, provider provider.IProvider) string { +func getIntroAuthMsg(authCtx *dto.AuthCtx, prov provider.IProvider) string { if authCtx != nil { if authCtx.Active { switch authCtx.Type { @@ -85,8 +85,10 @@ func getIntroAuthMsg(authCtx *dto.AuthCtx, provider provider.IProvider) string { case dto.AuthServiceAccountStr, dto.AuthApiKeyStr: return fmt.Sprintf(saSuccessMsgTmpl, authCtx.GetCredentialsSourceDescriptorString(), authCtx.Type) } - } else if err := provider.CheckCredentialFile(authCtx); authCtx.HasKey() && err != nil { - return fmt.Sprintf(saFileErrorMsgTmpl, authCtx.GetCredentialsSourceDescriptorString()) + } else if prov != nil { + if err := prov.CheckCredentialFile(authCtx); authCtx.HasKey() && err != nil { + return fmt.Sprintf(saFileErrorMsgTmpl, authCtx.GetCredentialsSourceDescriptorString()) + } } switch authCtx.Type { case dto.AuthServiceAccountStr, dto.AuthApiKeyStr: @@ -124,15 +126,20 @@ var shellCmd = &cobra.Command{ if handlerrErr != nil { fmt.Fprintln(outErrFile, fmt.Sprintf("Error setting up handler context for provider '%s'", runtimeCtx.ProviderStr)) } - provider, pErr := handlerCtx.GetProvider(handlerCtx.RuntimeContext.ProviderStr) - authCtx, authErr := handlerCtx.GetAuthContext(provider.GetProviderString()) - if authErr != nil { - fmt.Fprintln(outErrFile, fmt.Sprintf("Error setting up AUTH for provider '%s'", handlerCtx.RuntimeContext.ProviderStr)) - } - if pErr == nil { - provider.ShowAuth(authCtx) - } else { - fmt.Fprintln(outErrFile, fmt.Sprintf("Error setting up API for provider '%s'", handlerCtx.RuntimeContext.ProviderStr)) + var authCtx *dto.AuthCtx + var prov provider.IProvider + var pErr, authErr error + if handlerCtx.RuntimeContext.ProviderStr != "" { + prov, pErr = handlerCtx.GetProvider(handlerCtx.RuntimeContext.ProviderStr) + authCtx, authErr = handlerCtx.GetAuthContext(prov.GetProviderString()) + if authErr != nil { + fmt.Fprintln(outErrFile, fmt.Sprintf("Error setting up AUTH for provider '%s'", handlerCtx.RuntimeContext.ProviderStr)) + } + if pErr == nil { + prov.ShowAuth(authCtx) + } else { + fmt.Fprintln(outErrFile, fmt.Sprintf("Error setting up API for provider '%s'", handlerCtx.RuntimeContext.ProviderStr)) + } } var readlineCfg *readline.Config @@ -167,7 +174,7 @@ var shellCmd = &cobra.Command{ fmt.Fprintln( outErrFile, - getIntroAuthMsg(authCtx, provider), + getIntroAuthMsg(authCtx, prov), ) for { diff --git a/internal/stackql/config/config.go b/internal/stackql/config/config.go index 345ee61b..aa3ad0be 100644 --- a/internal/stackql/config/config.go +++ b/internal/stackql/config/config.go @@ -16,32 +16,18 @@ const defaultNixConfigCacheDirFileMode uint32 = 0755 const defaultWindowsConfigCacheDirFileMode uint32 = 0777 -const defaultConfigFileName = ".iqlrc" - -const defaultKeyFileName = "sa-key.json" +const defaultConfigFileName = ".stackqlrc" const defaltLogLevel = "warn" const defaltErrorPresentation = "stderr" -const googleProvider = "google" - -const oktaProvider = "okta" - const readlineDir = "readline" const readlineTmpFile = "readline.tmp" const defaultDbEngine = "sqlite3" -func GetGoogleProviderString() string { - return googleProvider -} - -func GetOktaProviderString() string { - return oktaProvider -} - func GetDefaultLogLevelString() string { return defaltLogLevel } @@ -58,7 +44,7 @@ func GetWorkingDir() string { return dir } -func GetDefaultProviderCacheRoot() string { +func GetDefaultApplicationFilesRoot() string { return path.Join(GetWorkingDir(), defaultConfigCacheDir) } @@ -74,11 +60,11 @@ func GetDefaultColorScheme() string { } func GetReadlineDirPath(runtimeCtx dto.RuntimeCtx) string { - return path.Join(runtimeCtx.ProviderRootPath, readlineDir) + return path.Join(runtimeCtx.ApplicationFilesRootPath, readlineDir) } func GetReadlineFilePath(runtimeCtx dto.RuntimeCtx) string { - return path.Join(runtimeCtx.ProviderRootPath, readlineDir, readlineTmpFile) + return path.Join(runtimeCtx.ApplicationFilesRootPath, readlineDir, readlineTmpFile) } func GetDefaultViperConfigFileName() string { diff --git a/internal/stackql/constants/constants.go b/internal/stackql/constants/constants.go index 77901364..4bd6d306 100644 --- a/internal/stackql/constants/constants.go +++ b/internal/stackql/constants/constants.go @@ -2,13 +2,12 @@ package constants const ( GoogleV1DiscoveryDoc string = "https://www.googleapis.com/discovery/v1/apis" - GoogleV1String string = "v1" GoogleV1OperationURLPropertyString string = "selfLink" GoogleV1ProviderCacheName string = "google_provider_v_0_3_7" stackqlKeyTmplStr string = "__KEY_TEMPLATE__" stackqlPathKey string = "name" - ServiceAccountRevokeErrStr string = `[INFO] Only interactive login credentials can be revoked, to authenticate with a different service account change the keyfilepath in the .iqlrc file or reauthenticate with a different service account using the AUTH command.` - ServiceAccountPathErrStr string = `[ERROR] keyfilepath not supplied or key file does not exist.` + ServiceAccountRevokeErrStr string = `[INFO] Only interactive login credentials can be revoked, to authenticate with a different service account change the credentialsfilepath in the .stackqlrc file or reauthenticate with a different service account using the AUTH command.` + ServiceAccountPathErrStr string = `[ERROR] credentialsfilepath not supplied or key file does not exist.` OAuthInteractiveAuthErrStr string = `[INFO] Interactive credentials must be revoked before logging in with a different user, use the AUTH REVOKE command before attempting to authenticate again.` NotAuthenticatedShowStr string = `[INFO] Not authenticated, use the AUTH command to authenticate to a provider.` JsonStr string = "json" diff --git a/internal/stackql/discovery/discovery.go b/internal/stackql/discovery/discovery.go index 91ae1bba..dce64803 100644 --- a/internal/stackql/discovery/discovery.go +++ b/internal/stackql/discovery/discovery.go @@ -2,29 +2,26 @@ package discovery import ( "fmt" - "io" - - "net/http" "github.com/stackql/stackql/internal/stackql/docparser" "github.com/stackql/stackql/internal/stackql/dto" - "github.com/stackql/stackql/internal/stackql/netutils" "github.com/stackql/stackql/internal/stackql/sqlengine" "gopkg.in/yaml.v2" "github.com/stackql/go-openapistackql/openapistackql" + "github.com/stackql/go-openapistackql/pkg/nomenclature" ) type IDiscoveryStore interface { ProcessProviderDiscoveryDoc(string, string) (*openapistackql.Provider, error) ProcessResourcesDiscoveryDoc(string, *openapistackql.ProviderService, string) (*openapistackql.ResourceRegister, error) - ProcessServiceDiscoveryDoc(string, *openapistackql.ProviderService, string) (*openapistackql.Service, error) PersistServiceShard(*openapistackql.Provider, *openapistackql.ProviderService, string) (*openapistackql.Service, error) } type TTLDiscoveryStore struct { sqlengine sqlengine.SQLEngine runtimeCtx dto.RuntimeCtx + registry openapistackql.RegistryAPI } type IDiscoveryAdapter interface { @@ -40,6 +37,7 @@ type BasicDiscoveryAdapter struct { apiDiscoveryDocUrl string discoveryStore IDiscoveryStore runtimeCtx *dto.RuntimeCtx + registry openapistackql.RegistryAPI } func NewBasicDiscoveryAdapter( @@ -47,12 +45,14 @@ func NewBasicDiscoveryAdapter( apiDiscoveryDocUrl string, discoveryStore IDiscoveryStore, runtimeCtx *dto.RuntimeCtx, + registry openapistackql.RegistryAPI, ) IDiscoveryAdapter { return &BasicDiscoveryAdapter{ alias: alias, apiDiscoveryDocUrl: apiDiscoveryDocUrl, discoveryStore: discoveryStore, runtimeCtx: runtimeCtx, + registry: registry, } } @@ -98,9 +98,9 @@ func (adp *BasicDiscoveryAdapter) GetResourcesMap(prov *openapistackql.Provider, } return disDoc.Resources, nil } - rr, err := component.GetResourcesShallow() + rr, err := adp.registry.GetResourcesShallowFromProviderService(component) if err != nil { - svc, err := component.GetService() + svc, err := adp.registry.GetServiceFromProviderService(component) if err != nil { return nil, err } @@ -114,101 +114,29 @@ func (adp *BasicDiscoveryAdapter) GetResourcesMap(prov *openapistackql.Provider, } -func NewTTLDiscoveryStore(sqlengine sqlengine.SQLEngine, runtimeCtx dto.RuntimeCtx) IDiscoveryStore { +func NewTTLDiscoveryStore(sqlengine sqlengine.SQLEngine, registry openapistackql.RegistryAPI, runtimeCtx dto.RuntimeCtx) IDiscoveryStore { return &TTLDiscoveryStore{ sqlengine: sqlengine, runtimeCtx: runtimeCtx, + registry: registry, } } -func DownloadDiscoveryDoc(url string, runtimeCtx dto.RuntimeCtx) (io.ReadCloser, error) { - httpClient := netutils.GetHttpClient(runtimeCtx, nil) - req, err := http.NewRequest(http.MethodGet, url, nil) - if err != nil { - return nil, err - } - res, getErr := httpClient.Do(req) - if getErr != nil { - return nil, err - } - if res.StatusCode >= 400 { - return nil, fmt.Errorf("discovery doc download for '%s' failed with code = %d", url, res.StatusCode) - } - return res.Body, nil -} - func (store *TTLDiscoveryStore) ProcessProviderDiscoveryDoc(url string, alias string) (*openapistackql.Provider, error) { switch url { case "https://www.googleapis.com/discovery/v1/apis": - return openapistackql.LoadProviderByName("google") - case "okta": - return openapistackql.LoadProviderByName("okta") - } - return nil, fmt.Errorf("cannot process provider discovery doc url = '%s'", url) -} - -func (store *TTLDiscoveryStore) ProcessServiceDiscoveryDoc(providerKey string, serviceHandle *openapistackql.ProviderService, alias string) (*openapistackql.Service, error) { - // k := fmt.Sprintf("%s.%s", providerKey, serviceHandle.Name) - switch providerKey { - case "googleapis.com", "google": - k := fmt.Sprintf("services.%s.%s", "google", serviceHandle.Name) - b, err := store.sqlengine.CacheStoreGet(k) - if b != nil && err == nil { - return openapistackql.LoadServiceDocFromBytes(b) - } - // pr, err := openapistackql.LoadProviderByName("google") - // if err != nil { - // return nil, err - // } - svc, err := serviceHandle.GetServiceFragment(serviceHandle.Name) - if err != nil { - svc, err = serviceHandle.GetServiceFragment(serviceHandle.ID) - } - if err != nil { - return nil, err - } - bt, err := svc.ToYaml() - if err != nil { - return nil, err - } - err = store.sqlengine.CacheStorePut(k, bt, "", 0) - if err != nil { - return nil, err - } - // err = docparser.OpenapiStackQLServiceDiscoveryDocPersistor(pr, svc, store.sqlengine, pr.Name) - return svc, err + return store.registry.LoadProviderByName("google", "v1") default: - k := fmt.Sprintf("%s.%s", providerKey, serviceHandle.Name) - b, err := store.sqlengine.CacheStoreGet(k) - if b != nil && err == nil { - return openapistackql.LoadServiceDocFromBytes(b) - } - pr, err := openapistackql.LoadProviderByName(providerKey) + ds, err := nomenclature.ExtractProviderDesignation(url) if err != nil { return nil, err } - svc, err := pr.GetService(serviceHandle.Name) - if err != nil { - svc, err = pr.GetService(serviceHandle.ID) - } - if err != nil { - return nil, err - } - bt, err := svc.ToYaml() - if err != nil { - return nil, err - } - err = store.sqlengine.CacheStorePut(k, bt, "", 0) - if err != nil { - return nil, err - } - // err = docparser.OpenapiStackQLServiceDiscoveryDocPersistor(pr, svc, store.sqlengine, pr.Name) - return svc, err + return store.registry.LoadProviderByName(ds.Name, ds.Tag) } } func (store *TTLDiscoveryStore) PersistServiceShard(pr *openapistackql.Provider, serviceHandle *openapistackql.ProviderService, resourceKey string) (*openapistackql.Service, error) { - k := fmt.Sprintf("services.%s.%s", "google", serviceHandle.Name) + k := fmt.Sprintf("services.%s.%s", pr.Name, serviceHandle.Name) svc, ok := serviceHandle.PeekServiceFragment(resourceKey) if ok && svc != nil { return svc, nil @@ -217,11 +145,10 @@ func (store *TTLDiscoveryStore) PersistServiceShard(pr *openapistackql.Provider, if b != nil && err == nil { return openapistackql.LoadServiceDocFromBytes(b) } - shard, err := serviceHandle.GetServiceFragment(resourceKey) + shard, err := store.registry.GetServiceFragment(serviceHandle, resourceKey) if err != nil { return nil, err } - // err = docparser.OpenapiStackQLServiceDiscoveryDocPersistor(pr, shard, store.sqlengine, pr.Name) if err != nil { return nil, err } @@ -230,7 +157,6 @@ func (store *TTLDiscoveryStore) PersistServiceShard(pr *openapistackql.Provider, } func (store *TTLDiscoveryStore) ProcessResourcesDiscoveryDoc(providerKey string, serviceHandle *openapistackql.ProviderService, alias string) (*openapistackql.ResourceRegister, error) { - // k := fmt.Sprintf("%s.%s", providerKey, serviceHandle.Name) switch providerKey { case "googleapis.com", "google": k := fmt.Sprintf("resources.%s.%s", "google", serviceHandle.Name) @@ -238,10 +164,7 @@ func (store *TTLDiscoveryStore) ProcessResourcesDiscoveryDoc(providerKey string, if b != nil && err == nil { return openapistackql.LoadResourcesShallow(b) } - rr, err := serviceHandle.GetResourcesShallow() - if err != nil { - rr, err = serviceHandle.GetResourcesShallow() - } + rr, err := store.registry.GetResourcesShallowFromProviderService(serviceHandle) if err != nil { return nil, err } @@ -253,7 +176,6 @@ func (store *TTLDiscoveryStore) ProcessResourcesDiscoveryDoc(providerKey string, if err != nil { return nil, err } - // err = docparser.OpenapiStackQLServiceDiscoveryDocPersistor(pr, svc, store.sqlengine, pr.Name) return rr, err default: k := fmt.Sprintf("%s.%s", providerKey, serviceHandle.Name) @@ -261,10 +183,7 @@ func (store *TTLDiscoveryStore) ProcessResourcesDiscoveryDoc(providerKey string, if b != nil && err == nil { return openapistackql.LoadResourcesShallow(b) } - rr, err := serviceHandle.GetResourcesShallow() - if err != nil { - rr, err = serviceHandle.GetResourcesShallow() - } + rr, err := store.registry.GetResourcesShallowFromProviderService(serviceHandle) if err != nil { return nil, err } @@ -279,7 +198,3 @@ func (store *TTLDiscoveryStore) ProcessResourcesDiscoveryDoc(providerKey string, return rr, nil } } - -// func (store *TTLDiscoveryStore) GetService(providerKey string, serviceHandle *openapistackql.ProviderService, alias string) (*openapistackql.Service, error) { - -// } diff --git a/internal/stackql/driver/aggregation_compute_disks_integration_test.go b/internal/stackql/driver/aggregation_compute_disks_integration_test.go index 9915d44c..5c373f7d 100644 --- a/internal/stackql/driver/aggregation_compute_disks_integration_test.go +++ b/internal/stackql/driver/aggregation_compute_disks_integration_test.go @@ -7,7 +7,6 @@ import ( "strings" "testing" - "github.com/stackql/stackql/internal/stackql/config" . "github.com/stackql/stackql/internal/stackql/driver" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/stackql/querysubmit" @@ -27,7 +26,7 @@ func TestMain(m *testing.M) { func TestSelectComputeDisksOrderByCrtTmstpAsc(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksOrderByCrtTmstpAsc") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksOrderByCrtTmstpAsc") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -69,7 +68,7 @@ func TestSelectComputeDisksOrderByCrtTmstpAsc(t *testing.T) { func TestSelectComputeDisksAggOrderBySizeAsc(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggOrderBySizeAsc") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggOrderBySizeAsc") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -111,7 +110,7 @@ func TestSelectComputeDisksAggOrderBySizeAsc(t *testing.T) { func TestSelectComputeDisksAggOrderBySizeDesc(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggOrderBySizeDesc") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggOrderBySizeDesc") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -153,7 +152,7 @@ func TestSelectComputeDisksAggOrderBySizeDesc(t *testing.T) { func TestSelectComputeDisksAggTotalSize(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggTotalSize") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggTotalSize") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -195,7 +194,7 @@ func TestSelectComputeDisksAggTotalSize(t *testing.T) { func TestSelectComputeDisksAggTotalString(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggTotalString") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggTotalString") if err != nil { t.Fatalf("Test failed: %v", err) } diff --git a/internal/stackql/driver/aggregation_container_subnetworks_integration_test.go b/internal/stackql/driver/aggregation_container_subnetworks_integration_test.go index 74f63daf..ccf5ac7e 100644 --- a/internal/stackql/driver/aggregation_container_subnetworks_integration_test.go +++ b/internal/stackql/driver/aggregation_container_subnetworks_integration_test.go @@ -6,7 +6,6 @@ import ( "strings" "testing" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/stackql/querysubmit" "github.com/stackql/stackql/internal/stackql/responsehandler" @@ -17,7 +16,7 @@ import ( ) func TestSimpleAggGoogleContainerSubnetworksGroupedAllowedDriverOutputAsc(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "table", "TestSimpleAggGoogleContainerSubnetworksGroupedAllowedDriverOutputAsc") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "table", "TestSimpleAggGoogleContainerSubnetworksGroupedAllowedDriverOutputAsc") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -58,7 +57,7 @@ func TestSimpleAggGoogleContainerSubnetworksGroupedAllowedDriverOutputAsc(t *tes } func TestSimpleAggGoogleContainerSubnetworksGroupedAllowedDriverOutputDesc(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "table", "TestSimpleAggGoogleContainerSubnetworksGroupedAllowedDriverOutputDesc") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "table", "TestSimpleAggGoogleContainerSubnetworksGroupedAllowedDriverOutputDesc") if err != nil { t.Fatalf("Test failed: %v", err) } diff --git a/internal/stackql/driver/aggregation_paginated_compute_disks_integration_test.go b/internal/stackql/driver/aggregation_paginated_compute_disks_integration_test.go index 01f1d3c9..f33305f7 100644 --- a/internal/stackql/driver/aggregation_paginated_compute_disks_integration_test.go +++ b/internal/stackql/driver/aggregation_paginated_compute_disks_integration_test.go @@ -5,7 +5,6 @@ import ( "strings" "testing" - "github.com/stackql/stackql/internal/stackql/config" . "github.com/stackql/stackql/internal/stackql/driver" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/stackql/querysubmit" @@ -18,7 +17,7 @@ import ( func TestSelectComputeDisksOrderByCrtTmstpAscPaginated(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksOrderByCrtTmstpAscPaginated") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksOrderByCrtTmstpAscPaginated") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -61,7 +60,7 @@ func TestSelectComputeDisksOrderByCrtTmstpAscPaginated(t *testing.T) { func TestSelectComputeDisksAggOrderBySizeAscPaginated(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggOrderBySizeAscPaginated") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggOrderBySizeAscPaginated") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -104,7 +103,7 @@ func TestSelectComputeDisksAggOrderBySizeAscPaginated(t *testing.T) { func TestSelectComputeDisksAggOrderBySizeDescPaginated(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggOrderBySizeDescPaginated") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggOrderBySizeDescPaginated") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -147,7 +146,7 @@ func TestSelectComputeDisksAggOrderBySizeDescPaginated(t *testing.T) { func TestSelectComputeDisksAggTotalSizePaginated(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggTotalSizePaginated") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggTotalSizePaginated") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -190,7 +189,7 @@ func TestSelectComputeDisksAggTotalSizePaginated(t *testing.T) { func TestSelectComputeDisksAggTotalStringPaginated(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggTotalStringPaginated") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectComputeDisksAggTotalStringPaginated") if err != nil { t.Fatalf("Test failed: %v", err) } diff --git a/internal/stackql/driver/dependent_simple_integration_test.go b/internal/stackql/driver/dependent_simple_integration_test.go index b508925c..7aef8832 100644 --- a/internal/stackql/driver/dependent_simple_integration_test.go +++ b/internal/stackql/driver/dependent_simple_integration_test.go @@ -9,7 +9,6 @@ import ( . "github.com/stackql/stackql/internal/stackql/driver" "github.com/stackql/stackql/internal/stackql/util" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/test/stackqltestutil" @@ -19,7 +18,7 @@ import ( ) func TestSimpleInsertDependentGoogleComputeDiskAsync(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleInsertDependentGoogleComputeDiskAsync") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleInsertDependentGoogleComputeDiskAsync") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -66,7 +65,7 @@ func TestSimpleInsertDependentGoogleComputeDiskAsync(t *testing.T) { } func TestSimpleInsertDependentGoogleComputeDiskAsyncReversed(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleInsertDependentGoogleComputeDiskAsyncReversed") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleInsertDependentGoogleComputeDiskAsyncReversed") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -113,7 +112,7 @@ func TestSimpleInsertDependentGoogleComputeDiskAsyncReversed(t *testing.T) { } func TestSimpleInsertDependentGoogleBQDatasetAsync(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleInsertDependentGoogleBQDatasetAsync") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleInsertDependentGoogleBQDatasetAsync") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -160,7 +159,7 @@ func TestSimpleInsertDependentGoogleBQDatasetAsync(t *testing.T) { } func TestSimpleSelectExecDependentGoogleOrganizationsGetIamPolicy(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "csv", "TestSimpleSelectExecDependentGoogleOrganizationsGetIamPolicy") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "csv", "TestSimpleSelectExecDependentGoogleOrganizationsGetIamPolicy") if err != nil { t.Fatalf("Test failed: %v", err) } diff --git a/internal/stackql/driver/driver_integration_test.go b/internal/stackql/driver/driver_integration_test.go index 60fe7b9c..cd37fdec 100644 --- a/internal/stackql/driver/driver_integration_test.go +++ b/internal/stackql/driver/driver_integration_test.go @@ -12,7 +12,6 @@ import ( . "github.com/stackql/stackql/internal/stackql/driver" "github.com/stackql/stackql/internal/stackql/util" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/stackql/handler" "github.com/stackql/stackql/internal/stackql/provider" @@ -27,7 +26,7 @@ import ( ) func TestSimpleSelectGoogleComputeInstanceDriver(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstanceDriver") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstanceDriver") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -71,7 +70,7 @@ func TestSimpleSelectGoogleComputeInstanceDriver(t *testing.T) { } func TestSimpleSelectGoogleComputeInstanceDriverOutput(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstanceDriverOutput") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstanceDriverOutput") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -112,7 +111,7 @@ func TestSimpleSelectGoogleComputeInstanceDriverOutput(t *testing.T) { } func TestSimpleSelectGoogleComputeInstanceDriverOutputRepeated(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstanceDriverOutputRepeated") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstanceDriverOutputRepeated") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -153,7 +152,7 @@ func TestSimpleSelectGoogleComputeInstanceDriverOutputRepeated(t *testing.T) { } func TestSimpleSelectGoogleContainerSubnetworksAllowedDriverOutput(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleContainerSubnetworksAllowedDriverOutput") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleContainerSubnetworksAllowedDriverOutput") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -194,7 +193,7 @@ func TestSimpleSelectGoogleContainerSubnetworksAllowedDriverOutput(t *testing.T) } func TestSimpleInsertGoogleComputeNetworkAsync(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleInsertGoogleComputeNetworkAsync") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleInsertGoogleComputeNetworkAsync") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -236,7 +235,7 @@ func TestSimpleInsertGoogleComputeNetworkAsync(t *testing.T) { func TestK8sTheHardWayAsync(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestK8sTheHardWayAsync") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestK8sTheHardWayAsync") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -288,7 +287,7 @@ func TestSimpleDryRunK8sTheHardWayDriver(t *testing.T) { testSubject := func(t *testing.T, outFile *bufio.Writer) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleDryRunK8sTheHardWayDriver") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleDryRunK8sTheHardWayDriver") if err != nil { t.Fatalf("TestSimpleDryRunDriver failed: %v", err) } diff --git a/internal/stackql/driver/functions_integration_test.go b/internal/stackql/driver/functions_integration_test.go index feb1385a..f185890a 100644 --- a/internal/stackql/driver/functions_integration_test.go +++ b/internal/stackql/driver/functions_integration_test.go @@ -8,7 +8,6 @@ import ( . "github.com/stackql/stackql/internal/stackql/driver" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/stackql/querysubmit" "github.com/stackql/stackql/internal/stackql/responsehandler" @@ -21,7 +20,7 @@ import ( func TestSelectComputeDisksOrderByCrtTmstpAscPlusJsonExtract(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "csv", "TestSelectComputeDisksOrderByCrtTmstpAscPlusJsonExtract") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "csv", "TestSelectComputeDisksOrderByCrtTmstpAscPlusJsonExtract") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -63,7 +62,7 @@ func TestSelectComputeDisksOrderByCrtTmstpAscPlusJsonExtract(t *testing.T) { func TestSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonExtract(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "csv", "TestSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonExtract") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "csv", "TestSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonExtract") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -105,7 +104,7 @@ func TestSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonExtract(t *testing. func TestSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonInstr(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "csv", "TestSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonInstr") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "csv", "TestSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonInstr") if err != nil { t.Fatalf("Test failed: %v", err) } diff --git a/internal/stackql/driver/okta_integration_test.go b/internal/stackql/driver/okta_integration_test.go index 0e9c17a0..fbea6b50 100644 --- a/internal/stackql/driver/okta_integration_test.go +++ b/internal/stackql/driver/okta_integration_test.go @@ -13,7 +13,6 @@ import ( "github.com/stackql/stackql/internal/stackql/responsehandler" "github.com/stackql/stackql/internal/stackql/util" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/stackql/handler" "github.com/stackql/stackql/internal/stackql/provider" @@ -37,7 +36,7 @@ func TestSelectOktaApplicationAppsDriver(t *testing.T) { t.Fatalf("%v", err) } - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSelectOktaApplicationAppsDriver") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSelectOktaApplicationAppsDriver") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -81,7 +80,7 @@ func TestSelectOktaApplicationAppsDriver(t *testing.T) { } func TestSimpleSelectOktaApplicationAppsDriverOutput(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleSelectOktaApplicationAppsDriverOutput") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleSelectOktaApplicationAppsDriverOutput") if err != nil { t.Fatalf("Test failed: %v", err) } diff --git a/internal/stackql/driver/routine_complex_integration_test.go b/internal/stackql/driver/routine_complex_integration_test.go index 69923949..0da9202d 100644 --- a/internal/stackql/driver/routine_complex_integration_test.go +++ b/internal/stackql/driver/routine_complex_integration_test.go @@ -8,7 +8,6 @@ import ( . "github.com/stackql/stackql/internal/stackql/driver" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/stackql/querysubmit" "github.com/stackql/stackql/internal/stackql/responsehandler" @@ -21,7 +20,7 @@ import ( func TestUnionAllSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonExtract(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "csv", "TestUnionAllSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonExtract") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "csv", "TestUnionAllSelectComputeDisksOrderByCrtTmstpAscPlusCoalesceJsonExtract") if err != nil { t.Fatalf("Test failed: %v", err) } diff --git a/internal/stackql/driver/show_insert_integration_test.go b/internal/stackql/driver/show_insert_integration_test.go index cdb4310d..c010222a 100644 --- a/internal/stackql/driver/show_insert_integration_test.go +++ b/internal/stackql/driver/show_insert_integration_test.go @@ -9,7 +9,6 @@ import ( . "github.com/stackql/stackql/internal/stackql/driver" "github.com/stackql/stackql/internal/stackql/util" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/test/stackqltestutil" @@ -22,7 +21,7 @@ func TestSimpleShowInsertComputeAddressesRequired(t *testing.T) { testSubject := func(t *testing.T, outFile *bufio.Writer) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleShowInsertComputeAddressesRequired") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleShowInsertComputeAddressesRequired") if err != nil { t.Fatalf("TestSimpleTemplateComputeAddressesRequired failed: %v", err) } @@ -67,7 +66,7 @@ func TestSimpleShowInsertBiqueryDatasets(t *testing.T) { testSubject := func(t *testing.T, outFile *bufio.Writer) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleShowInsertBiqueryDatasets") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleShowInsertBiqueryDatasets") if err != nil { t.Fatalf("TestSimpleShowInsertBiqueryDatasets failed: %v", err) } @@ -112,7 +111,7 @@ func TestSimpleShowInsertBiqueryDatasetsRequired(t *testing.T) { testSubject := func(t *testing.T, outFile *bufio.Writer) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleShowInsertBiqueryDatasetsRequired") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleShowInsertBiqueryDatasetsRequired") if err != nil { t.Fatalf("TestSimpleShowInsertBiqueryDatasetsRequired failed: %v", err) } diff --git a/internal/stackql/driver/show_various_integration_test.go b/internal/stackql/driver/show_various_integration_test.go index 5c8bfeed..06c004cb 100644 --- a/internal/stackql/driver/show_various_integration_test.go +++ b/internal/stackql/driver/show_various_integration_test.go @@ -9,7 +9,6 @@ import ( . "github.com/stackql/stackql/internal/stackql/driver" "github.com/stackql/stackql/internal/stackql/util" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/entryutil" "github.com/stackql/stackql/internal/test/stackqltestutil" @@ -22,7 +21,7 @@ func TestSimpleShowResourcesFiltered(t *testing.T) { testSubject := func(t *testing.T, outFile *bufio.Writer) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleShowResourcesFiltered") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleShowResourcesFiltered") if err != nil { t.Fatalf("TestSimpleShowResourcesFiltered failed: %v", err) } @@ -68,7 +67,7 @@ func TestSimpleShowBQDatasets(t *testing.T) { testSubject := func(t *testing.T, outFile *bufio.Writer) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleShowBQDatasets") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleShowBQDatasets") if err != nil { t.Fatalf("TestSimpleShowResourcesFiltered failed: %v", err) } @@ -114,7 +113,7 @@ func TestSimpleShowGoogleStorageBuckets(t *testing.T) { testSubject := func(t *testing.T, outFile *bufio.Writer) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleShowGoogleStorageBuckets") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleShowGoogleStorageBuckets") if err != nil { t.Fatalf("TestSimpleShowResourcesFiltered failed: %v", err) } diff --git a/internal/stackql/dto/dto.go b/internal/stackql/dto/dto.go index cd003c46..1927052f 100644 --- a/internal/stackql/dto/dto.go +++ b/internal/stackql/dto/dto.go @@ -12,51 +12,56 @@ import ( ) const ( - AuthApiKeyStr string = "api_key" - AuthInteractiveStr string = "interactive" - AuthServiceAccountStr string = "serviceaccount" - DarkColorScheme string = "dark" - LightColorScheme string = "light" - NullColorScheme string = "null" - DefaultColorScheme string = DarkColorScheme - DefaultWindowsColorScheme string = NullColorScheme - DryRunFlagKey string = "dryrun" - AuthCtxKey string = "auth" - APIRequestTimeoutKey string = "apirequesttimeout" - CacheKeyCountKey string = "cachekeycount" - CacheTTLKey string = "metadatattl" - ColorSchemeKey string = "colorscheme" - ConfigFilePathKey string = "configfile" - CPUProfileKey string = "cpuprofile" - CSVHeadersDisableKey string = "hideheaders" - DbEngineKey string = "dbengine" - DbGenerationIdKey string = "dbgenerationid" - DbFilePathKey string = "dbfilepath" - DbInitFilePathKey string = "dbinitfilepath" - DelimiterKey string = "delimiter" - ErrorPresentationKey string = "errorpresentation" - HTTPLogEnabledKey string = "http.log.enabled" - HTTPMaxResultsKey string = "http.response.maxResults" - HTTPProxyHostKey string = "http.proxy.host" - HTTPProxyPasswordKey string = "http.proxy.password" - HTTPProxyPortKey string = "http.proxy.port" - HTTPProxySchemeKey string = "http.proxy.scheme" - HTTPProxyUserKey string = "http.proxy.user" - InfilePathKey string = "infile" - LogLevelStrKey string = "loglevel" - OutfilePathKey string = "outfile" - OutputFormatKey string = "output" - ProviderRootPathKey string = "providerroot" - ProviderRootPathModeKey string = "providerrootfilemode" - ProviderStrKey string = "provider" - QueryCacheSizeKey string = "querycachesize" - ReinitKey string = "reinit" - TemplateCtxFilePathKey string = "iqldata" - TestWithoutApiCallsKey string = "testwithoutapicalls" - UseNonPreferredAPIsKEy string = "usenonpreferredapis" - VerboseFlagKey string = "verbose" - ViperCfgFileNameKey string = "viperconfigfilename" - WorkOfflineKey string = "offline" + AuthApiKeyStr string = "api_key" + AuthBasicStr string = "basic" + AuthInteractiveStr string = "interactive" + AuthServiceAccountStr string = "service_account" + AuthNullStr string = "null_auth" + DarkColorScheme string = "dark" + LightColorScheme string = "light" + NullColorScheme string = "null" + DefaultColorScheme string = DarkColorScheme + DefaultWindowsColorScheme string = NullColorScheme + DryRunFlagKey string = "dryrun" + AuthCtxKey string = "auth" + APIRequestTimeoutKey string = "apirequesttimeout" + CacheKeyCountKey string = "cachekeycount" + CacheTTLKey string = "metadatattl" + ColorSchemeKey string = "colorscheme" + ConfigFilePathKey string = "configfile" + CPUProfileKey string = "cpuprofile" + CSVHeadersDisableKey string = "hideheaders" + DbEngineKey string = "dbengine" + DbGenerationIdKey string = "dbgenerationid" + DbFilePathKey string = "dbfilepath" + DbInitFilePathKey string = "dbinitfilepath" + DelimiterKey string = "delimiter" + ErrorPresentationKey string = "errorpresentation" + HTTPLogEnabledKey string = "http.log.enabled" + HTTPMaxResultsKey string = "http.response.maxResults" + HTTPProxyHostKey string = "http.proxy.host" + HTTPProxyPasswordKey string = "http.proxy.password" + HTTPProxyPortKey string = "http.proxy.port" + HTTPProxySchemeKey string = "http.proxy.scheme" + HTTPProxyUserKey string = "http.proxy.user" + CABundleKey string = "tls.CABundle" + AllowInsecureKey string = "tls.allowInsecure" + InfilePathKey string = "infile" + LogLevelStrKey string = "loglevel" + OutfilePathKey string = "outfile" + OutputFormatKey string = "output" + ApplicationFilesRootPathKey string = "approot" + ApplicationFilesRootPathModeKey string = "approotfilemode" + ProviderStrKey string = "provider" + QueryCacheSizeKey string = "querycachesize" + RegistryRawKey string = "registry" + ReinitKey string = "reinit" + TemplateCtxFilePathKey string = "iqldata" + TestWithoutApiCallsKey string = "testwithoutapicalls" + UseNonPreferredAPIsKEy string = "usenonpreferredapis" + VerboseFlagKey string = "verbose" + ViperCfgFileNameKey string = "viperconfigfilename" + WorkOfflineKey string = "offline" ) type KeyVal struct { @@ -84,13 +89,18 @@ type HTTPElement struct { type AuthCtx struct { Scopes []string `json:"scopes,omitempty" yaml:"scopes,omitempty"` - Type string `json:"keyfiletype" yaml:"keyfiletype"` + Type string `json:"type" yaml:"type"` ID string `json:"-" yaml:"-"` - KeyFilePath string `json:"keyfilepath" yaml:"keyfilepath"` - KeyEnvVar string `json:"keyenvvar" yaml:"keyenvvar"` + KeyFilePath string `json:"credentialsfilepath" yaml:"credentialsfilepath"` + KeyEnvVar string `json:"credentialsenvvar" yaml:"credentialsenvvar"` Active bool `json:"-" yaml:"-"` } +type RegistryCtx struct { + Url string `json:"url" yaml:"url"` + UseEmbedded bool `json:"useEmbedded" yaml:"useEmbedded"` +} + func (ac *AuthCtx) HasKey() bool { if ac.KeyFilePath != "" || ac.KeyEnvVar != "" { return true @@ -118,7 +128,7 @@ func (ac *AuthCtx) GetCredentialsBytes() ([]byte, error) { if ac.KeyEnvVar != "" { rv := os.Getenv(ac.KeyEnvVar) if rv == "" { - return nil, fmt.Errorf("keyenvvar references empty string") + return nil, fmt.Errorf("credentialsenvvar references empty string") } return []byte(rv), nil } @@ -128,9 +138,9 @@ func (ac *AuthCtx) GetCredentialsBytes() ([]byte, error) { func (ac *AuthCtx) GetCredentialsSourceDescriptorString() string { if ac.KeyEnvVar != "" { - return fmt.Sprintf("keyenvvar:%s", ac.KeyEnvVar) + return fmt.Sprintf("credentialsenvvar:%s", ac.KeyEnvVar) } - return fmt.Sprintf("keyfilepath:%s", ac.KeyFilePath) + return fmt.Sprintf("credentialsfilepath:%s", ac.KeyFilePath) } type ExecPayload struct { @@ -162,43 +172,46 @@ func GetAuthCtx(scopes []string, keyFilePath string, keyFileType string) *AuthCt } type RuntimeCtx struct { - APIRequestTimeout int - AuthRaw string - CacheKeyCount int - CacheTTL int - ColorScheme string - ConfigFilePath string - CPUProfile string - CSVHeadersDisable bool - DbEngine string - DbFilePath string - DbGenerationId int - DbInitFilePath string - Delimiter string - DryRunFlag bool - ErrorPresentation string - HTTPLogEnabled bool - HTTPMaxResults int - HTTPProxyHost string - HTTPProxyPassword string - HTTPProxyPort int - HTTPProxyScheme string - HTTPProxyUser string - InfilePath string - LogLevelStr string - OutfilePath string - OutputFormat string - ProviderRootPath string - ProviderRootPathMode uint32 - ProviderStr string - Reinit bool - QueryCacheSize int - TemplateCtxFilePath string - TestWithoutApiCalls bool - UseNonPreferredAPIs bool - VerboseFlag bool - ViperCfgFileName string - WorkOffline bool + APIRequestTimeout int + AuthRaw string + CABundle string + AllowInsecure bool + CacheKeyCount int + CacheTTL int + ColorScheme string + ConfigFilePath string + CPUProfile string + CSVHeadersDisable bool + DbEngine string + DbFilePath string + DbGenerationId int + DbInitFilePath string + Delimiter string + DryRunFlag bool + ErrorPresentation string + HTTPLogEnabled bool + HTTPMaxResults int + HTTPProxyHost string + HTTPProxyPassword string + HTTPProxyPort int + HTTPProxyScheme string + HTTPProxyUser string + InfilePath string + LogLevelStr string + OutfilePath string + OutputFormat string + ApplicationFilesRootPath string + ApplicationFilesRootPathMode uint32 + ProviderStr string + RegistryRaw string + Reinit bool + QueryCacheSize int + TemplateCtxFilePath string + TestWithoutApiCalls bool + UseNonPreferredAPIs bool + VerboseFlag bool + ViperCfgFileName string + WorkOffline bool } func setInt(iPtr *int, val string) error { @@ -232,6 +245,8 @@ func (rc *RuntimeCtx) Set(key string, val string) error { retVal = setInt(&rc.APIRequestTimeout, val) case AuthCtxKey: rc.AuthRaw = val + case CABundleKey: + rc.CABundle = val case CacheKeyCountKey: retVal = setInt(&rc.CacheKeyCount, val) case CacheTTLKey: @@ -280,12 +295,14 @@ func (rc *RuntimeCtx) Set(key string, val string) error { rc.OutfilePath = val case OutputFormatKey: rc.OutputFormat = val - case ProviderRootPathKey: - rc.ProviderRootPath = val - case ProviderRootPathModeKey: - retVal = setUint32(&rc.ProviderRootPathMode, val) + case ApplicationFilesRootPathKey: + rc.ApplicationFilesRootPath = val + case ApplicationFilesRootPathModeKey: + retVal = setUint32(&rc.ApplicationFilesRootPathMode, val) case QueryCacheSizeKey: retVal = setInt(&rc.QueryCacheSize, val) + case RegistryRawKey: + rc.RegistryRaw = val case ReinitKey: retVal = setBool(&rc.Reinit, val) case TemplateCtxFilePathKey: diff --git a/internal/stackql/google_sdk/gcloud.go b/internal/stackql/google_sdk/gcloud.go index eafb6c97..2b44626d 100644 --- a/internal/stackql/google_sdk/gcloud.go +++ b/internal/stackql/google_sdk/gcloud.go @@ -10,7 +10,7 @@ import ( const ( gcloudErrFmt string = "gcloud error: %s" - gcloudInstallInfo string = `Visit https://cloud.google.com/sdk to download the SDK or alternatively use serviceaccount mode, see https://docs.stackql.io/language-spec/auth for more information` + gcloudInstallInfo string = `Visit https://cloud.google.com/sdk to download the SDK or alternatively use service_account mode, see https://docs.stackql.io/language-spec/auth for more information` gcloudNotPresentError string = `Interactive mode requires the Google Cloud SDK to be installed on the system being used for stackql. ` + gcloudInstallInfo gcloudRevokeError string = "Error revoking gcloud credentials. Please ensure that gcloud is installed and credentials are valid before running this command. " + gcloudInstallInfo ) diff --git a/internal/stackql/handler/handler.go b/internal/stackql/handler/handler.go index 37d66006..5bdb5c44 100644 --- a/internal/stackql/handler/handler.go +++ b/internal/stackql/handler/handler.go @@ -4,9 +4,12 @@ import ( "fmt" "io" + "github.com/stackql/go-openapistackql/openapistackql" + "github.com/stackql/go-openapistackql/pkg/nomenclature" "github.com/stackql/stackql/internal/pkg/txncounter" "github.com/stackql/stackql/internal/stackql/drm" "github.com/stackql/stackql/internal/stackql/dto" + "github.com/stackql/stackql/internal/stackql/netutils" "github.com/stackql/stackql/internal/stackql/provider" "github.com/stackql/stackql/internal/stackql/sqlengine" @@ -25,6 +28,7 @@ type HandlerContext struct { providers map[string]provider.IProvider CurrentProvider string authContexts map[string]*dto.AuthCtx + Registry openapistackql.RegistryAPI ErrorPresentation string Outfile io.Writer OutErrFile io.Writer @@ -34,14 +38,44 @@ type HandlerContext struct { TxnCounterMgr *txncounter.TxnCounterManager } +func getProviderMap(providerName string) map[string]interface{} { + googleMap := map[string]interface{}{ + "name": providerName, + } + return googleMap +} + +func getProviderMapExtended(providerName string) map[string]interface{} { + return getProviderMap(providerName) +} + +func (hc *HandlerContext) GetSupportedProviders(extended bool) map[string]map[string]interface{} { + retVal := make(map[string]map[string]interface{}) + for pn := range hc.Registry.ListLocallyAvailableProviders() { + if pn == "googleapis.com" { + pn = "google" + } + if extended { + retVal[pn] = getProviderMapExtended(pn) + } else { + retVal[pn] = getProviderMap(pn) + } + } + return retVal +} + func (hc *HandlerContext) GetProvider(providerName string) (provider.IProvider, error) { var err error if providerName == "" { providerName = hc.RuntimeContext.ProviderStr } + ds, err := nomenclature.ExtractProviderDesignation(providerName) + if err != nil { + return nil, err + } prov, ok := hc.providers[providerName] if !ok { - prov, err = provider.GetProvider(hc.RuntimeContext, providerName, "v1", hc.SQLEngine) + prov, err = provider.GetProvider(hc.RuntimeContext, ds.Name, ds.Tag, hc.Registry, hc.SQLEngine) if err == nil { hc.providers[providerName] = prov return prov, err @@ -63,24 +97,44 @@ func (hc *HandlerContext) GetAuthContext(providerName string) (*dto.AuthCtx, err return authCtx, err } -func GetHandlerCtx(cmdString string, runtimeCtx dto.RuntimeCtx, lruCache *lrucache.LRUCache, sqlEng sqlengine.SQLEngine) (HandlerContext, error) { - prov, err := provider.GetProviderFromRuntimeCtx(runtimeCtx, sqlEng) +func GetRegistry(runtimeCtx dto.RuntimeCtx) (openapistackql.RegistryAPI, error) { + return getRegistry(runtimeCtx) +} + +func getRegistry(runtimeCtx dto.RuntimeCtx) (openapistackql.RegistryAPI, error) { + var rc openapistackql.RegistryConfig + err := yaml.Unmarshal([]byte(runtimeCtx.RegistryRaw), &rc) if err != nil { - return HandlerContext{}, err + return nil, err + } + if rc.LocalDocRoot == "" { + rc.LocalDocRoot = runtimeCtx.ApplicationFilesRootPath } + rt := netutils.GetRoundTripper(runtimeCtx, nil) + return openapistackql.NewRegistry(rc, rt) +} + +func GetHandlerCtx(cmdString string, runtimeCtx dto.RuntimeCtx, lruCache *lrucache.LRUCache, sqlEng sqlengine.SQLEngine) (HandlerContext, error) { ac := make(map[string]*dto.AuthCtx) - err = yaml.Unmarshal([]byte(runtimeCtx.AuthRaw), ac) + err := yaml.Unmarshal([]byte(runtimeCtx.AuthRaw), ac) + if err != nil { + return HandlerContext{}, err + } + reg, err := getRegistry(runtimeCtx) + if err != nil { + return HandlerContext{}, err + } + providers := make(map[string]provider.IProvider) if err != nil { return HandlerContext{}, err } return HandlerContext{ - RawQuery: cmdString, - RuntimeContext: runtimeCtx, - providers: map[string]provider.IProvider{ - runtimeCtx.ProviderStr: prov, - }, + RawQuery: cmdString, + RuntimeContext: runtimeCtx, + providers: providers, authContexts: ac, + Registry: reg, ErrorPresentation: runtimeCtx.ErrorPresentation, LRUCache: lruCache, SQLEngine: sqlEng, diff --git a/internal/stackql/httpbuild/request.go b/internal/stackql/httpbuild/request.go index b62b9298..6c69d4fb 100644 --- a/internal/stackql/httpbuild/request.go +++ b/internal/stackql/httpbuild/request.go @@ -70,7 +70,7 @@ func BuildHTTPRequestCtx(handlerCtx *handler.HandlerContext, node sqlparser.SQLN requestSchema = m.Request.Schema } if m.Response != nil && m.Response.Schema != nil { - requestSchema = m.Response.Schema + responseSchema = m.Response.Schema } httpArmoury.RequestSchema = requestSchema httpArmoury.ResponseSchema = responseSchema @@ -93,10 +93,6 @@ func BuildHTTPRequestCtx(handlerCtx *handler.HandlerContext, node sqlparser.SQLN for j, v := range execContext.ExecPayload.Header { pm.Header[j] = v } - // rb := make(map[string]interface{}) - // for k, v := range execContext.ExecPayload.PayloadMap { - // rb[k] = v - // } params.RequestBody = execContext.ExecPayload.PayloadMap } else if params.RequestBody != nil && len(params.RequestBody) != 0 { b, err := json.Marshal(params.RequestBody) @@ -106,6 +102,11 @@ func BuildHTTPRequestCtx(handlerCtx *handler.HandlerContext, node sqlparser.SQLN pm.BodyBytes = b pm.Header["Content-Type"] = []string{m.Request.BodyMediaType} } + if m.Response != nil { + if m.Response.BodyMediaType != "" { + pm.Header["Accept"] = []string{m.Response.BodyMediaType} + } + } pm.Parameters = params httpArmoury.RequestParams = append(httpArmoury.RequestParams, pm) } @@ -118,6 +119,11 @@ func BuildHTTPRequestCtx(handlerCtx *handler.HandlerContext, node sqlparser.SQLN switch node := node.(type) { case *sqlparser.Delete, *sqlparser.Exec, *sqlparser.Insert, *sqlparser.Select: baseRequestCtx, err = getRequest(svc, m, p.Parameters) + for k, v := range p.Header { + for _, vi := range v { + baseRequestCtx.Header.Set(k, vi) + } + } p.Request = baseRequestCtx default: return nil, fmt.Errorf("cannot create http primitive for sql node of type %T", node) @@ -128,7 +134,6 @@ func BuildHTTPRequestCtx(handlerCtx *handler.HandlerContext, node sqlparser.SQLN log.Infoln(fmt.Sprintf("pre transform: httpArmoury.RequestParams[%d] = %s", i, string(p.BodyBytes))) if handlerCtx.RuntimeContext.HTTPLogEnabled { url, _ := p.Context.GetUrl() - // fmt.Printf("url for request = %s\n", url) handlerCtx.OutErrFile.Write([]byte(fmt.Sprintln(fmt.Sprintf("http request url: %s", url)))) } log.Infoln(fmt.Sprintf("post transform: httpArmoury.RequestParams[%d] = %s", i, string(p.BodyBytes))) diff --git a/internal/stackql/httpexec/httpexec.go b/internal/stackql/httpexec/httpexec.go index 537d5500..58d23f22 100644 --- a/internal/stackql/httpexec/httpexec.go +++ b/internal/stackql/httpexec/httpexec.go @@ -11,6 +11,7 @@ import ( "net/http" "net/url" + "github.com/stackql/go-openapistackql/openapistackql" "github.com/stackql/stackql/internal/stackql/util" log "github.com/sirupsen/logrus" @@ -194,16 +195,16 @@ func marshalResponse(r *http.Response) (interface{}, error) { return nil, err } switch mediaType { - case "application/json": + case openapistackql.MediaTypeJson: err = json.NewDecoder(body).Decode(&target) - case "application/xml": + case openapistackql.MediaTypeXML: err = xml.NewDecoder(body).Decode(&target) - case "application/octet-stream": + case openapistackql.MediaTypeOctetStream: target, err = io.ReadAll(body) - case "text/plain", "text/html": + case openapistackql.MediaTypeTextPlain, openapistackql.MediaTypeHTML: var b []byte b, err = io.ReadAll(body) - if err != nil { + if err == nil { target = string(b) } default: @@ -222,6 +223,10 @@ func ProcessHttpResponse(response *http.Response) (interface{}, error) { return map[string]interface{}{"result": "The Operation Completed Successfully"}, nil } } + switch rv := target.(type) { + case string, int: + return map[string]interface{}{openapistackql.AnonymousColumnName: []interface{}{rv}}, nil + } return target, err } @@ -235,6 +240,10 @@ func DeprecatedProcessHttpResponse(response *http.Response) (map[string]interfac return rv, nil case nil: return nil, nil + case string: + return map[string]interface{}{openapistackql.AnonymousColumnName: rv}, nil + case []byte: + return map[string]interface{}{openapistackql.AnonymousColumnName: string(rv)}, nil default: return nil, fmt.Errorf("DeprecatedProcessHttpResponse() cannot acccept response of type %T", rv) } diff --git a/internal/stackql/iqlerror/iqlerror.go b/internal/stackql/iqlerror/iqlerror.go index d45bf4d1..5a52924e 100644 --- a/internal/stackql/iqlerror/iqlerror.go +++ b/internal/stackql/iqlerror/iqlerror.go @@ -17,6 +17,11 @@ func PrintErrorAndExitOneIfNil(subject interface{}, msg string) { } } +func PrintErrorAndExitOneWithMessage(msg string) { + fmt.Fprintln(os.Stderr, fmt.Sprintln(msg)) + os.Exit(1) +} + func PrintErrorAndExitOneIfError(err error) { if err != nil { fmt.Fprintln(os.Stderr, fmt.Sprintln(err.Error())) diff --git a/internal/stackql/methodselect/methodselect.go b/internal/stackql/methodselect/methodselect.go index 3416e078..5556a204 100644 --- a/internal/stackql/methodselect/methodselect.go +++ b/internal/stackql/methodselect/methodselect.go @@ -15,24 +15,22 @@ type IMethodSelector interface { func NewMethodSelector(provider string, version string) (IMethodSelector, error) { switch provider { - case "google", "okta": + default: return newGoogleMethodSelector(version) } - return nil, fmt.Errorf("method selector for provider = '%s', api version = '%s' currently not supported", provider, version) } func newGoogleMethodSelector(version string) (IMethodSelector, error) { switch version { - case "v1": - return &DefaultGoogleMethodSelector{}, nil + default: + return &DefaultMethodSelector{}, nil } - return nil, fmt.Errorf("method selector for google, api version = '%s' currently not supported", version) } -type DefaultGoogleMethodSelector struct { +type DefaultMethodSelector struct { } -func (sel *DefaultGoogleMethodSelector) GetMethodForAction(resource *openapistackql.Resource, iqlAction string) (*openapistackql.OperationStore, string, error) { +func (sel *DefaultMethodSelector) GetMethodForAction(resource *openapistackql.Resource, iqlAction string) (*openapistackql.OperationStore, string, error) { var methodName string switch strings.ToLower(iqlAction) { case "select": @@ -58,11 +56,11 @@ func (sel *DefaultGoogleMethodSelector) GetMethodForAction(resource *openapistac return m, methodName, err } -func (sel *DefaultGoogleMethodSelector) GetMethod(resource *openapistackql.Resource, methodName string) (*openapistackql.OperationStore, error) { +func (sel *DefaultMethodSelector) GetMethod(resource *openapistackql.Resource, methodName string) (*openapistackql.OperationStore, error) { return sel.getMethodByName(resource, methodName) } -func (sel *DefaultGoogleMethodSelector) getMethodByName(resource *openapistackql.Resource, methodName string) (*openapistackql.OperationStore, error) { +func (sel *DefaultMethodSelector) getMethodByName(resource *openapistackql.Resource, methodName string) (*openapistackql.OperationStore, error) { m, err := resource.FindMethod(methodName) if err != nil { return nil, fmt.Errorf("no method = '%s' for resource = '%s'", methodName, resource.Name) diff --git a/internal/stackql/netutils/http_proxy.go b/internal/stackql/netutils/http_proxy.go index 8cb8de88..95bab061 100644 --- a/internal/stackql/netutils/http_proxy.go +++ b/internal/stackql/netutils/http_proxy.go @@ -1,19 +1,26 @@ package netutils import ( + "crypto/tls" + "crypto/x509" "fmt" "net/http" "net/url" + "os" "time" "github.com/stackql/stackql/internal/stackql/dto" ) -func GetHttpClient(runtimeCtx dto.RuntimeCtx, existingClient *http.Client) *http.Client { +func GetRoundTripper(runtimeCtx dto.RuntimeCtx, existingTransport http.RoundTripper) http.RoundTripper { + return getRoundTripper(runtimeCtx, existingTransport) +} + +func getRoundTripper(runtimeCtx dto.RuntimeCtx, existingTransport http.RoundTripper) http.RoundTripper { var tr *http.Transport var rt http.RoundTripper - if existingClient != nil && existingClient.Transport != nil { - switch exTR := existingClient.Transport.(type) { + if existingTransport != nil { + switch exTR := existingTransport.(type) { case *http.Transport: tr = exTR.Clone() default: @@ -22,6 +29,21 @@ func GetHttpClient(runtimeCtx dto.RuntimeCtx, existingClient *http.Client) *http } else { tr = &http.Transport{} } + if runtimeCtx.CABundle != "" { + rootCAs, err := getCertPool(runtimeCtx.CABundle) + if err == nil { + config := &tls.Config{ + InsecureSkipVerify: runtimeCtx.AllowInsecure, + RootCAs: rootCAs, + } + tr.TLSClientConfig = config + } + } else if runtimeCtx.AllowInsecure { + config := &tls.Config{ + InsecureSkipVerify: runtimeCtx.AllowInsecure, + } + tr.TLSClientConfig = config + } host := runtimeCtx.HTTPProxyHost if host != "" { if runtimeCtx.HTTPProxyPort > 0 { @@ -43,8 +65,43 @@ func GetHttpClient(runtimeCtx dto.RuntimeCtx, existingClient *http.Client) *http if tr != nil { rt = tr } + return rt +} + +func GetHttpClient(runtimeCtx dto.RuntimeCtx, existingClient *http.Client) *http.Client { + return getHttpClient(runtimeCtx, existingClient) +} + +func getHttpClient(runtimeCtx dto.RuntimeCtx, existingClient *http.Client) *http.Client { + var rt http.RoundTripper + if existingClient != nil && existingClient.Transport != nil { + rt = existingClient.Transport + } return &http.Client{ Timeout: time.Second * time.Duration(runtimeCtx.APIRequestTimeout), - Transport: rt, + Transport: getRoundTripper(runtimeCtx, rt), + } +} + +func getCertPool(localCaBundlePath string) (*x509.CertPool, error) { + var lb []byte + var err error + if localCaBundlePath != "" { + lb, err = os.ReadFile(localCaBundlePath) + if err != nil { + return nil, err + } + } + sp, err := x509.SystemCertPool() + if err == nil && sp != nil { + if lb != nil { + sp.AppendCertsFromPEM(lb) + } + return sp, nil + } + vp := x509.NewCertPool() + if lb != nil { + vp.AppendCertsFromPEM(lb) } + return vp, nil } diff --git a/internal/stackql/planbuilder/primitive_generator.go b/internal/stackql/planbuilder/primitive_generator.go index d82ab9ce..a6f7c367 100644 --- a/internal/stackql/planbuilder/primitive_generator.go +++ b/internal/stackql/planbuilder/primitive_generator.go @@ -19,7 +19,6 @@ import ( "github.com/stackql/stackql/internal/stackql/primitive" "github.com/stackql/stackql/internal/stackql/primitivebuilder" "github.com/stackql/stackql/internal/stackql/primitivegraph" - "github.com/stackql/stackql/internal/stackql/provider" "github.com/stackql/stackql/internal/stackql/relational" "github.com/stackql/stackql/internal/stackql/symtab" "github.com/stackql/stackql/internal/stackql/taxonomy" @@ -343,7 +342,7 @@ func (pb *primitiveGenerator) showInstructionExecutor(node *sqlparser.Show, hand } keys = methodKeys case "PROVIDERS": - keys = provider.GetSupportedProviders(extended) + keys = handlerCtx.GetSupportedProviders(extended) case "RESOURCES": svcName := node.OnTable.Name.GetRawVal() if svcName == "" { diff --git a/internal/stackql/planbuilder/statement_analyzer.go b/internal/stackql/planbuilder/statement_analyzer.go index 81b1514d..adf0fd4c 100644 --- a/internal/stackql/planbuilder/statement_analyzer.go +++ b/internal/stackql/planbuilder/statement_analyzer.go @@ -792,7 +792,6 @@ func (p *primitiveGenerator) analyzeSelect(handlerCtx *handler.HandlerContext, n case *sqlparser.ExecSubquery: log.Infoln(fmt.Sprintf("from = %v", from)) tbl, err = pChild.analyzeTableExpr(handlerCtx, from) - // return fmt.Errorf("from clause of type - '%T' currently not supported", from) default: tbl, err = pChild.analyzeTableExpr(handlerCtx, from) } @@ -824,6 +823,9 @@ func (p *primitiveGenerator) analyzeSelect(handlerCtx *handler.HandlerContext, n if err != nil { return err } + if len(cols) == 0 { + cols = openapistackql.Schemas{openapistackql.AnonymousColumnName: responseSchema} + } for colName, colSchema := range cols { if colSchema == nil { return fmt.Errorf("could not infer column information") @@ -1160,11 +1162,13 @@ func (p *primitiveGenerator) analyzeDelete(handlerCtx *handler.HandlerContext, n } schema, err := method.GetResponseBodySchema() if err != nil { - return err + log.Infof("no response schema for delete: %s \n", err.Error()) } - whereErr := p.analyzeSingleTableWhere(node.Where, schema) - if whereErr != nil { - return whereErr + if schema != nil { + whereErr := p.analyzeSingleTableWhere(node.Where, schema) + if whereErr != nil { + return whereErr + } } colPrefix := prov.GetDefaultKeyForDeleteItems() + "[]." whereNames, err := parserutil.ExtractWhereColNames(node.Where) @@ -1176,6 +1180,9 @@ func (p *primitiveGenerator) analyzeDelete(handlerCtx *handler.HandlerContext, n if ok { continue } + if schema == nil { + return fmt.Errorf("cannot locate parameter '%s'", w) + } log.Infoln(fmt.Sprintf("w = '%s'", w)) foundSchemaPrefixed := schema.FindByPath(colPrefix+w, nil) foundSchema := schema.FindByPath(w, nil) diff --git a/internal/stackql/primitivebuilder/builder.go b/internal/stackql/primitivebuilder/builder.go index c8fcb87f..8b2abe4b 100644 --- a/internal/stackql/primitivebuilder/builder.go +++ b/internal/stackql/primitivebuilder/builder.go @@ -423,6 +423,12 @@ func (ss *SingleSelectAcquire) Build() error { for i := range iArr { item, ok := iArr[i].(map[string]interface{}) + if !ok { + if iArr[i] != nil { + item = map[string]interface{}{openapistackql.AnonymousColumnName: iArr[i]} + ok = true + } + } if ok { log.Infoln(fmt.Sprintf("running insert with control parameters: %v", ss.insertPreparedStatementCtx.TxnCtrlCtrs)) diff --git a/internal/stackql/provider/auth_util.go b/internal/stackql/provider/auth_util.go index e2b98f23..dbd6e283 100644 --- a/internal/stackql/provider/auth_util.go +++ b/internal/stackql/provider/auth_util.go @@ -14,6 +14,7 @@ import ( "golang.org/x/oauth2" "golang.org/x/oauth2/google" + "golang.org/x/oauth2/jwt" ) var ( @@ -28,14 +29,70 @@ type serviceAccount struct { type transport struct { token []byte authType string + tokenLocation string + key string underlyingTransport http.RoundTripper } +func newTransport(token []byte, authType, tokenLocation, key string, underlyingTransport http.RoundTripper) (*transport, error) { + switch authType { + case authTypeBasic, authTypeBearer, authTypeSSWS: + if len(token) < 1 { + return nil, fmt.Errorf("no credentials provided for auth type = '%s'", authType) + } + if tokenLocation != locationHeader { + return nil, fmt.Errorf("improper location provided for auth type = '%s', provided = '%s', expected = '%s'", authType, tokenLocation, locationHeader) + } + default: + switch tokenLocation { + case locationHeader: + case locationQuery: + if key == "" { + return nil, fmt.Errorf("key required for query param based auth") + } + default: + return nil, fmt.Errorf("token location not supported: '%s'", tokenLocation) + } + } + return &transport{ + token: token, + authType: authType, + tokenLocation: tokenLocation, + key: key, + underlyingTransport: underlyingTransport, + }, nil +} + +const ( + locationHeader string = "header" + locationQuery string = "query" + authTypeBasic string = "BASIC" + authTypeBearer string = "Bearer" + authTypeSSWS string = "SSWS" +) + func (t *transport) RoundTrip(req *http.Request) (*http.Response, error) { - req.Header.Set( - "Authorization", - fmt.Sprintf("%s %s", t.authType, string(t.token)), - ) + switch t.tokenLocation { + case locationHeader: + switch t.authType { + case authTypeBasic, authTypeBearer, authTypeSSWS: + req.Header.Set( + "Authorization", + fmt.Sprintf("%s %s", t.authType, string(t.token)), + ) + default: + req.Header.Set( + t.key, + string(t.token), + ) + } + case locationQuery: + qv := req.URL.Query() + qv.Set( + t.key, string(t.token), + ) + req.URL.RawQuery = qv.Encode() + } return t.underlyingTransport.RoundTrip(req) } @@ -60,12 +117,21 @@ func parseServiceAccountFile(ac *dto.AuthCtx) (serviceAccount, error) { return c, json.Unmarshal(b, &c) } -func oauthServiceAccount(authCtx *dto.AuthCtx, scopes []string, runtimeCtx dto.RuntimeCtx) (*http.Client, error) { +func getJWTConfig(provider string, credentialsBytes []byte, scopes []string) (*jwt.Config, error) { + switch provider { + case "google": + return google.JWTConfigFromJSON(credentialsBytes, scopes...) + default: + return nil, fmt.Errorf("service account auth for provider = '%s' currently not supported", provider) + } +} + +func oauthServiceAccount(provider string, authCtx *dto.AuthCtx, scopes []string, runtimeCtx dto.RuntimeCtx) (*http.Client, error) { b, err := authCtx.GetCredentialsBytes() if err != nil { return nil, fmt.Errorf("service account credentials error: %v", err) } - config, errToken := google.JWTConfigFromJSON(b, scopes...) + config, errToken := getJWTConfig(provider, b, scopes) if errToken != nil { return nil, errToken } @@ -84,10 +150,25 @@ func apiTokenAuth(authCtx *dto.AuthCtx, runtimeCtx dto.RuntimeCtx) (*http.Client } activateAuth(authCtx, "", "api_key") httpClient := netutils.GetHttpClient(runtimeCtx, http.DefaultClient) - httpClient.Transport = &transport{ - token: b, - authType: "SSWS", - underlyingTransport: httpClient.Transport, + tr, err := newTransport(b, authTypeSSWS, locationHeader, "", httpClient.Transport) + if err != nil { + return nil, err + } + httpClient.Transport = tr + return httpClient, nil +} + +func basicAuth(authCtx *dto.AuthCtx, runtimeCtx dto.RuntimeCtx) (*http.Client, error) { + b, err := authCtx.GetCredentialsBytes() + if err != nil { + return nil, fmt.Errorf("credentials error: %v", err) + } + activateAuth(authCtx, "", "basic") + httpClient := netutils.GetHttpClient(runtimeCtx, http.DefaultClient) + tr, err := newTransport(b, authTypeBasic, locationHeader, "", httpClient.Transport) + if err != nil { + return nil, err } + httpClient.Transport = tr return httpClient, nil } diff --git a/internal/stackql/provider/generic.go b/internal/stackql/provider/generic.go index 883e7299..59a35c71 100644 --- a/internal/stackql/provider/generic.go +++ b/internal/stackql/provider/generic.go @@ -36,13 +36,6 @@ type GenericProvider struct { methodSelector methodselect.IMethodSelector } -func (gp *GenericProvider) getDefaultKeyForSelectItems(sc *openapistackql.Schema) string { - if gp.provider.SelectItemsKey != "" { - return gp.provider.SelectItemsKey - } - return "items" -} - func (gp *GenericProvider) GetDiscoveryGeneration(dbEngine sqlengine.SQLEngine) (int, error) { return dbEngine.GetCurrentDiscoveryGenerationId(gp.GetProviderString()) } @@ -75,23 +68,30 @@ func (gp *GenericProvider) inferAuthType(authCtx dto.AuthCtx, authTypeRequested return dto.AuthServiceAccountStr case dto.AuthInteractiveStr: return dto.AuthInteractiveStr + case dto.AuthNullStr: + return dto.AuthNullStr } if authCtx.KeyFilePath != "" || authCtx.KeyEnvVar != "" { return dto.AuthServiceAccountStr } - return dto.AuthInteractiveStr + return dto.AuthNullStr } func (gp *GenericProvider) Auth(authCtx *dto.AuthCtx, authTypeRequested string, enforceRevokeFirst bool) (*http.Client, error) { - switch gp.inferAuthType(*authCtx, authTypeRequested) { + at := gp.inferAuthType(*authCtx, authTypeRequested) + switch at { case dto.AuthApiKeyStr: return gp.apiTokenFileAuth(authCtx) case dto.AuthServiceAccountStr: return gp.keyFileAuth(authCtx) + case dto.AuthBasicStr: + return gp.basicAuth(authCtx) case dto.AuthInteractiveStr: return gp.oAuth(authCtx, enforceRevokeFirst) + case dto.AuthNullStr: + return netutils.GetHttpClient(gp.runtimeCtx, http.DefaultClient), nil } - return nil, fmt.Errorf("Could not infer auth type") + return nil, fmt.Errorf("could not infer auth type") } func (gp *GenericProvider) AuthRevoke(authCtx *dto.AuthCtx) error { @@ -223,11 +223,11 @@ func (gp *GenericProvider) oAuth(authCtx *dto.AuthCtx, enforceRevokeFirst bool) } activateAuth(authCtx, "", dto.AuthInteractiveStr) client := netutils.GetHttpClient(gp.runtimeCtx, nil) - client.Transport = &transport{ - token: tokenBytes, - authType: "Bearer", - underlyingTransport: client.Transport, + tr, err := newTransport(tokenBytes, authTypeBearer, locationHeader, "", client.Transport) + if err != nil { + return nil, err } + client.Transport = tr return client, nil } @@ -238,13 +238,17 @@ func (gp *GenericProvider) keyFileAuth(authCtx *dto.AuthCtx) (*http.Client, erro "https://www.googleapis.com/auth/cloud-platform", } } - return oauthServiceAccount(authCtx, scopes, gp.runtimeCtx) + return oauthServiceAccount(gp.GetProviderString(), authCtx, scopes, gp.runtimeCtx) } func (gp *GenericProvider) apiTokenFileAuth(authCtx *dto.AuthCtx) (*http.Client, error) { return apiTokenAuth(authCtx, gp.runtimeCtx) } +func (gp *GenericProvider) basicAuth(authCtx *dto.AuthCtx) (*http.Client, error) { + return basicAuth(authCtx, gp.runtimeCtx) +} + func (gp *GenericProvider) getServiceType(service *openapistackql.Service) string { specialServiceNamesMap := map[string]bool{ "storage": true, diff --git a/internal/stackql/provider/google.go b/internal/stackql/provider/google.go deleted file mode 100644 index 2cd5025b..00000000 --- a/internal/stackql/provider/google.go +++ /dev/null @@ -1,12 +0,0 @@ -package provider - -func getProviderMap(providerName string) map[string]interface{} { - googleMap := map[string]interface{}{ - "name": providerName, - } - return googleMap -} - -func getProviderMapExtended(providerName string) map[string]interface{} { - return getProviderMap(providerName) -} diff --git a/internal/stackql/provider/provider.go b/internal/stackql/provider/provider.go index 70f02297..845a8f1c 100644 --- a/internal/stackql/provider/provider.go +++ b/internal/stackql/provider/provider.go @@ -1,11 +1,8 @@ package provider import ( - "fmt" - "net/http" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/constants" "github.com/stackql/stackql/internal/stackql/discovery" "github.com/stackql/stackql/internal/stackql/docparser" @@ -19,8 +16,6 @@ import ( const ( ambiguousServiceErrorMessage string = "More than one service exists with this name, please use the id in the object name, or unset the --usenonpreferredapis flag" - googleProviderName string = "google" - oktaProviderName string = "okta" SchemaDelimiter string = docparser.SchemaDelimiter ) @@ -32,18 +27,6 @@ type ProviderParam struct { Format string } -func GetSupportedProviders(extended bool) map[string]map[string]interface{} { - retVal := make(map[string]map[string]interface{}) - if extended { - retVal[googleProviderName] = getProviderMapExtended(googleProviderName) - retVal[oktaProviderName] = getProviderMapExtended(oktaProviderName) - } else { - retVal[googleProviderName] = getProviderMap(googleProviderName) - retVal[oktaProviderName] = getProviderMap(oktaProviderName) - } - return retVal -} - type IProvider interface { Auth(authCtx *dto.AuthCtx, authTypeRequested string, enforceRevokeFirst bool) (*http.Client, error) @@ -100,30 +83,23 @@ type IProvider interface { GetDiscoveryGeneration(sqlengine.SQLEngine) (int, error) } -func GetProviderFromRuntimeCtx(runtimeCtx dto.RuntimeCtx, dbEngine sqlengine.SQLEngine) (IProvider, error) { - providerStr := runtimeCtx.ProviderStr - return GetProvider(runtimeCtx, providerStr, "v1", dbEngine) -} - -func GetProvider(runtimeCtx dto.RuntimeCtx, providerStr, providerVersion string, dbEngine sqlengine.SQLEngine) (IProvider, error) { +func GetProvider(runtimeCtx dto.RuntimeCtx, providerStr, providerVersion string, reg openapistackql.RegistryAPI, dbEngine sqlengine.SQLEngine) (IProvider, error) { switch providerStr { - case config.GetGoogleProviderString(), config.GetOktaProviderString(): - return newGenericProvider(runtimeCtx, providerStr, providerVersion, dbEngine) + default: + return newGenericProvider(runtimeCtx, providerStr, providerVersion, reg, dbEngine) } - return nil, fmt.Errorf("provider %s not supported", providerStr) } func getUrl(prov string) (string, error) { switch prov { case "google": return constants.GoogleV1DiscoveryDoc, nil - case "okta": - return "okta", nil + default: + return prov, nil } - return "", fmt.Errorf("cannot find root doc for provider = '%s'", prov) } -func newGenericProvider(rtCtx dto.RuntimeCtx, providerStr, versionStr string, dbEngine sqlengine.SQLEngine) (IProvider, error) { +func newGenericProvider(rtCtx dto.RuntimeCtx, providerStr, versionStr string, reg openapistackql.RegistryAPI, dbEngine sqlengine.SQLEngine) (IProvider, error) { methSel, err := methodselect.NewMethodSelector(providerStr, versionStr) if err != nil { return nil, err @@ -139,9 +115,11 @@ func newGenericProvider(rtCtx dto.RuntimeCtx, providerStr, versionStr string, db rootUrl, discovery.NewTTLDiscoveryStore( dbEngine, + reg, rtCtx, ), &rtCtx, + reg, ) p, err := da.GetProvider(rtCtx.ProviderStr) diff --git a/internal/stackql/querysubmit/querysubmit_integration_test.go b/internal/stackql/querysubmit/querysubmit_integration_test.go index 35f12bfe..1072902c 100644 --- a/internal/stackql/querysubmit/querysubmit_integration_test.go +++ b/internal/stackql/querysubmit/querysubmit_integration_test.go @@ -8,7 +8,6 @@ import ( "github.com/stackql/stackql/internal/stackql/entryutil" . "github.com/stackql/stackql/internal/stackql/querysubmit" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/handler" "github.com/stackql/stackql/internal/stackql/provider" @@ -20,7 +19,7 @@ import ( ) func TestSimpleSelectGoogleComputeInstanceQuerySubmit(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstanceQuerySubmit") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstanceQuerySubmit") if err != nil { t.Fatalf("Test failed: %v", err) } diff --git a/internal/stackql/taxonomy/taxonomy.go b/internal/stackql/taxonomy/taxonomy.go index b3b019ba..4e5a6469 100644 --- a/internal/stackql/taxonomy/taxonomy.go +++ b/internal/stackql/taxonomy/taxonomy.go @@ -35,7 +35,17 @@ func (ho *HeirarchyObjects) LookupSelectItemsKey() string { if method == nil { return defaultSelectItemsKEy } - responseSchema, _ := method.GetResponseBodySchema() + if sk := method.GetSelectItemsKey(); sk != "" { + return sk + } + responseSchema, err := method.GetResponseBodySchema() + if responseSchema == nil || err != nil { + return "" + } + switch responseSchema.Type { + case "string", "integer": + return openapistackql.AnonymousColumnName + } if prov.GetProviderString() == "google" { sn := svcHdl.GetName() if sn == "bigquery" && svcHdl.Info.Version == "v2" { @@ -237,7 +247,11 @@ func (ho *HeirarchyObjects) GetSelectableObjectSchema() (*openapistackql.Schema, if err != nil { return nil, err } - itemObjS, _, err := responseObj.GetSelectSchema(ho.LookupSelectItemsKey()) + itemsKey := ho.Method.Response.ObjectKey + if itemsKey == "" { + itemsKey = ho.LookupSelectItemsKey() + } + itemObjS, _, err := responseObj.GetSelectSchema(itemsKey) if itemObjS == nil || err != nil { return nil, fmt.Errorf("could not locate dml object for response type '%v'", ho.Method.Response.ObjectKey) } @@ -318,7 +332,6 @@ func GetHeirarchyFromStatement(handlerCtx *handler.HandlerContext, node sqlparse case *sqlparser.Select: methodAction = "select" case *sqlparser.DescribeTable: - case sqlparser.TableName: case *sqlparser.AliasedTableExpr: return GetHeirarchyFromStatement(handlerCtx, n.Expr) diff --git a/internal/stackql/util/utility.go b/internal/stackql/util/utility.go index 0572d67c..c33b2770 100644 --- a/internal/stackql/util/utility.go +++ b/internal/stackql/util/utility.go @@ -1,6 +1,7 @@ package util import ( + "path" "path/filepath" "runtime" "strings" @@ -13,6 +14,13 @@ func GetFilePathFromRepositoryRoot(relativePath string) (string, error) { return strings.ReplaceAll(rv, `\`, `\\`), err } +func GetForwardSlashFilePathFromRepositoryRoot(relativePath string) (string, error) { + _, filename, _, _ := runtime.Caller(0) + curDir := path.Dir(filename) + rv, err := filepath.Abs(path.Join(curDir, "../../..", relativePath)) + return filepath.ToSlash(rv), err +} + func MaxMapKey(numbers map[int]interface{}) int { var maxNumber int for maxNumber = range numbers { diff --git a/internal/test/stackqltestutil/locator.go b/internal/test/stackqltestutil/locator.go index 1af47a9c..f577f781 100644 --- a/internal/test/stackqltestutil/locator.go +++ b/internal/test/stackqltestutil/locator.go @@ -19,7 +19,7 @@ func GetRuntimeCtx(providerStr string, outputFmtStr string, testName string) (*d if err != nil { return nil, fmt.Errorf("test failed on %s: %v", saKeyPath, err) } - providerDir, err := util.GetFilePathFromRepositoryRoot("test/.stackql") + appRoot, err := util.GetFilePathFromRepositoryRoot("test/.stackql") if err != nil { return nil, fmt.Errorf("test failed: %v", err) } @@ -27,15 +27,20 @@ func GetRuntimeCtx(providerStr string, outputFmtStr string, testName string) (*d if err != nil { return nil, fmt.Errorf("test failed on %s: %v", dbInitFilePath, err) } + registryRoot, err := util.GetForwardSlashFilePathFromRepositoryRoot("test/registry") + if err != nil { + return nil, fmt.Errorf("test failed on %s: %v", dbInitFilePath, err) + } return &dto.RuntimeCtx{ - Delimiter: ",", - ProviderStr: providerStr, - LogLevelStr: "warn", - AuthRaw: fmt.Sprintf(`{ "google": { "keyfilepath": "%s" }, "okta": { "keyfilepath": "%s", "keyfiletype": "api_key" } }`, saKeyPath, oktaSaKeyPath), - ProviderRootPath: providerDir, - OutputFormat: outputFmtStr, - DbFilePath: fmt.Sprintf("file:%s?mode=memory&cache=shared", testName), - DbInitFilePath: dbInitFilePath, + Delimiter: ",", + ProviderStr: providerStr, + LogLevelStr: "warn", + ApplicationFilesRootPath: appRoot, + AuthRaw: fmt.Sprintf(`{ "google": { "credentialsfilepath": "%s" }, "okta": { "credentialsfilepath": "%s", "type": "api_key" } }`, saKeyPath, oktaSaKeyPath), + RegistryRaw: fmt.Sprintf(`{ "url": "file://%s", "useEmbedded": false }`, registryRoot), + OutputFormat: outputFmtStr, + DbFilePath: fmt.Sprintf("file:%s?mode=memory&cache=shared", testName), + DbInitFilePath: dbInitFilePath, }, nil } diff --git a/internal/test/testobjects/input.go b/internal/test/testobjects/input.go index 75e71aaf..8e19cb99 100644 --- a/internal/test/testobjects/input.go +++ b/internal/test/testobjects/input.go @@ -55,3 +55,7 @@ const ( SelectGoogleComputeDisksAggSizeTotal string = `select sum(cast(sizeGb as unsigned)) - 10 as cc from google.compute.disks where zone = 'australia-southeast1-b' AND /* */ project = 'testing-project';` SelectGoogleComputeDisksAggStringTotal string = `select group_concat(substr(name, 0, 5)) || ' lalala' as cc from google.compute.disks where zone = 'australia-southeast1-b' AND /* */ project = 'testing-project';` ) + +func GetGoogleProviderString() string { + return "google" +} diff --git a/stackql/.gitignore b/stackql/.gitignore new file mode 100644 index 00000000..0301d238 --- /dev/null +++ b/stackql/.gitignore @@ -0,0 +1 @@ +.stackql \ No newline at end of file diff --git a/stackql/main_integration_test.go b/stackql/main_integration_test.go index f520834f..ff84556a 100644 --- a/stackql/main_integration_test.go +++ b/stackql/main_integration_test.go @@ -3,7 +3,6 @@ package main import ( "fmt" - "github.com/stackql/stackql/internal/stackql/config" "github.com/stackql/stackql/internal/stackql/provider" "github.com/stackql/stackql/internal/stackql/util" @@ -18,7 +17,7 @@ import ( ) func TestSimpleSelectGoogleComputeInstance(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstance") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestSimpleSelectGoogleComputeInstance") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -34,7 +33,7 @@ func TestSimpleSelectGoogleComputeInstance(t *testing.T) { args := []string{ "--loglevel=warn", fmt.Sprintf("--auth=%s", runtimeCtx.AuthRaw), - fmt.Sprintf("--providerroot=%s", runtimeCtx.ProviderRootPath), + fmt.Sprintf("--registry=%s", runtimeCtx.RegistryRaw), fmt.Sprintf("--dbfilepath=%s", runtimeCtx.DbFilePath), fmt.Sprintf("--dbinitfilepath=%s", runtimeCtx.DbInitFilePath), fmt.Sprintf("--dbgenerationid=%d", 1), @@ -53,7 +52,7 @@ func TestSimpleSelectGoogleComputeInstance(t *testing.T) { func TestK8STemplatedE2eSuccess(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestK8STemplatedE2eSuccess") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestK8STemplatedE2eSuccess") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -66,7 +65,7 @@ func TestK8STemplatedE2eSuccess(t *testing.T) { args := []string{ "--loglevel=warn", fmt.Sprintf("--auth=%s", runtimeCtx.AuthRaw), - fmt.Sprintf("--providerroot=%s", runtimeCtx.ProviderRootPath), + fmt.Sprintf("--registry=%s", runtimeCtx.RegistryRaw), fmt.Sprintf("--dbfilepath=%s", runtimeCtx.DbFilePath), fmt.Sprintf("--dbinitfilepath=%s", runtimeCtx.DbInitFilePath), fmt.Sprintf("-i=%s", k8sthwRenderedFile), @@ -83,7 +82,7 @@ func TestK8STemplatedE2eSuccess(t *testing.T) { func TestInsertAwaitExecSuccess(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestInsertAwaitExecSuccess") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestInsertAwaitExecSuccess") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -91,7 +90,7 @@ func TestInsertAwaitExecSuccess(t *testing.T) { args := []string{ "--loglevel=warn", fmt.Sprintf("--auth=%s", runtimeCtx.AuthRaw), - fmt.Sprintf("--providerroot=%s", runtimeCtx.ProviderRootPath), + fmt.Sprintf("--registry=%s", runtimeCtx.RegistryRaw), fmt.Sprintf("--dbfilepath=%s", runtimeCtx.DbFilePath), fmt.Sprintf("--dbinitfilepath=%s", runtimeCtx.DbInitFilePath), "-i=stdin", @@ -109,7 +108,7 @@ func TestInsertAwaitExecSuccess(t *testing.T) { func TestDeleteAwaitSuccess(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestDeleteAwaitSuccess") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestDeleteAwaitSuccess") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -117,7 +116,7 @@ func TestDeleteAwaitSuccess(t *testing.T) { args := []string{ "--loglevel=warn", fmt.Sprintf("--auth=%s", runtimeCtx.AuthRaw), - fmt.Sprintf("--providerroot=%s", runtimeCtx.ProviderRootPath), + fmt.Sprintf("--registry=%s", runtimeCtx.RegistryRaw), fmt.Sprintf("--dbfilepath=%s", runtimeCtx.DbFilePath), fmt.Sprintf("--dbinitfilepath=%s", runtimeCtx.DbInitFilePath), "-i=stdin", @@ -135,7 +134,7 @@ func TestDeleteAwaitSuccess(t *testing.T) { func TestDeleteAwaitExecSuccess(t *testing.T) { - runtimeCtx, err := stackqltestutil.GetRuntimeCtx(config.GetGoogleProviderString(), "text", "TestDeleteAwaitExecSuccess") + runtimeCtx, err := stackqltestutil.GetRuntimeCtx(testobjects.GetGoogleProviderString(), "text", "TestDeleteAwaitExecSuccess") if err != nil { t.Fatalf("Test failed: %v", err) } @@ -143,7 +142,7 @@ func TestDeleteAwaitExecSuccess(t *testing.T) { args := []string{ "--loglevel=warn", fmt.Sprintf("--auth=%s", runtimeCtx.AuthRaw), - fmt.Sprintf("--providerroot=%s", runtimeCtx.ProviderRootPath), + fmt.Sprintf("--registry=%s", runtimeCtx.RegistryRaw), fmt.Sprintf("--dbfilepath=%s", runtimeCtx.DbFilePath), fmt.Sprintf("--dbinitfilepath=%s", runtimeCtx.DbInitFilePath), "-i=stdin", diff --git a/test/assets/credentials/dummy/google/functional-test-dummy-sa-key.json b/test/assets/credentials/dummy/google/functional-test-dummy-sa-key.json new file mode 100644 index 00000000..02dda379 --- /dev/null +++ b/test/assets/credentials/dummy/google/functional-test-dummy-sa-key.json @@ -0,0 +1,12 @@ +{ + "type": "service_account", + "project_id": "silly-project-01", + "private_key_id": "silly-key-id", + "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAsTfIs92qRg+srgviU9EHJfcgjn/38QFJTa0xYPSNSLSj4hXw\niyPyZ4ih6nIfW2NP4tvwK3piQrmHx/pQesrp5exKF3b97tf+Cvf9gM+i/3wJGhEb\nE24Py91+/5aXf6TfkuhNutZ3v5qzHYRtWcr3AXcD2WAThF6hxmvQTFTYqcyUb6vl\nt7evG6OleifU5rAKmD8Odk8Hs1skwAmlWjWT1uouWVegFv53a8eUilNiBSnYy/PA\nYchL2fGI8Os+CFyju+ns6dG9H7bAOywvZZaTzlVNvJ42gop03l5xzEwHkUKlcukg\nhyDtP5FTeD5liYUJ/Xqq6Xn6Rjck/AgTwqYePwIDAQABAoIBAQCdS08X3oJ4hwcU\nwDWVgW1f1DYQZSLzxdmDWVr/nHAefT8Mt752MWTBYnOcfMi6O663Q9GrNYgrgzMy\nW0m9g4cRbaXhp9sBeLLil3RpNWKOc1A807v9he39W86SGt7DC9rpMMl1MVC+PxgF\n9fl8/no40aMX+H+6OKhMTntmlNRt+E1WUIGBk9cScb37e+oAStfS0Z6c8kQ9CkOZ\nHwydCtq8gQDpkRYMM3m7j3j9mr2Rma1o8xcBbgbomYn6y2xPQf1B4rs9fb8txngv\nGxA+QSRSXNMQmQFLmoc6d3XHFZQ5LX7atRhHsnt4blb8GNqJg8FsTFED68cWKoNp\n0Lk7c/9xAoGBAOLplpGdg3ezAMtFR5gAi8pV9vGJairJsuBij22uK0rItNkaff4G\nYyciybCKJZfXTcOzYq/CGh8KwxhN6RECmHm+bHfnxFDdHXS8e0bs8oTlR7w3yHs4\nhrplBMCwyAgSsma7s8aNBfdkDlPMxYmvytWdHf3T4mj6C5LGlFzpTLmpAoGBAMfv\naHNPLCoJjvQmNlzboN0sLZYhRl2YgW86mM0MoW7pO4cY4On5twbdFD7AtHIKF4j5\nomsMVfTDvKZ+jbHoJFuvvhozq0T/LpEx5b6d27A4pfacmG0zNaLaopoDYQ6wBvYD\n4L9OScFRrtf/X3ZgLzsmNpEVlqyUU2tbCAJVa5mnAoGBAI7ODVmVNPD3Mc+7ySPr\nbA6p7WDzZ2KIT9ARl0yiqVJGYDKmDpb5NBukNCSrvJ8D/EfmtHwCf2f74O6B0eVH\nqegspJ0NuqpdjjUyja8EXliu52eX/880su3Jt6UBXNJf2fD3vlt90zxvtuicXdGa\nVd/8IqzlVX9VpkT4PtT+arAJAoGAZkmknYG+7Y7QVTaLj3xJ0327oNhLQK06YyaO\ncDFrEew/KUHgJ7Q7IEbRCb3bU5C4M7rLjorUGxJdHK0YXxGOMF48GvmeQQFw2JW3\nnYrzjzecKQw6q3uMkFHc6ICcEkCafxjCzf0GnOHmWtlrBIv2/gLx3c42tPp5py3+\nbfs3vncCgYEA0x6tF67q3zt+daUMUox6LimkkDJLsfqnmKjvHFAhKQaqOObWaody\nfGOzlf/KLX15uicYWeCwRrs03OjBfk6LEtVddsZOrjJEp8+6gA8KEf58MJhNuRVj\no3qSe9po1TMj0/hvzd32klXslpqQjXFjm9U3lAxfcRdgWsG7SciOAAs=\n-----END RSA PRIVATE KEY-----\n", + "client_email": "silly-sa@silly-project-01.iam.gserviceaccount.com", + "client_id": "11", + "auth_uri": "https://accounts.google.com/o/oauth2/auth", + "token_uri": "https://localhost:1080/token", + "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", + "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/silly-sa%40silly-project-01.iam.gserviceaccount.com" +} \ No newline at end of file diff --git a/test/assets/input/empty-templated-show-services-extended-filtered.iql b/test/assets/input/empty-templated-show-services-extended-filtered.iql index fbce92d9..7862b3c5 100644 --- a/test/assets/input/empty-templated-show-services-extended-filtered.iql +++ b/test/assets/input/empty-templated-show-services-extended-filtered.iql @@ -1,3 +1,3 @@ -show extended services where description like '{{ .service.description }}' and version = '{{ .service.version }}'; +show extended services from google where description like '{{ .service.description }}' and version = '{{ .service.version }}'; diff --git a/test/assets/input/json-templated-show-services-extended-filtered.iql b/test/assets/input/json-templated-show-services-extended-filtered.iql index 4cc982ef..dcebcec7 100644 --- a/test/assets/input/json-templated-show-services-extended-filtered.iql +++ b/test/assets/input/json-templated-show-services-extended-filtered.iql @@ -21,5 +21,5 @@ >>> -show extended services where description like '{{ .service.description }}' and version = '{{ .service.version }}'; +show extended services from google where description like '{{ .service.description }}' and version = '{{ .service.version }}'; diff --git a/test/assets/input/jsonnet-templated-show-services-extended-filtered.iql b/test/assets/input/jsonnet-templated-show-services-extended-filtered.iql index e2ad0007..c84db86b 100644 --- a/test/assets/input/jsonnet-templated-show-services-extended-filtered.iql +++ b/test/assets/input/jsonnet-templated-show-services-extended-filtered.iql @@ -27,5 +27,5 @@ local svc_version = 'v1'; >>> -show extended services where description like '{{ .service.description }}' and version = '{{ .service.version }}'; +show extended services from google where description like '{{ .service.description }}' and version = '{{ .service.version }}'; diff --git a/test/downloads/.gitignore b/test/downloads/.gitignore new file mode 100644 index 00000000..c96a04f0 --- /dev/null +++ b/test/downloads/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore \ No newline at end of file diff --git a/test/dummyserver/dummy_server.py b/test/dummyserver/dummy_server.py deleted file mode 100644 index 29e30254..00000000 --- a/test/dummyserver/dummy_server.py +++ /dev/null @@ -1,47 +0,0 @@ -# Python 3 server example -from http.server import BaseHTTPRequestHandler, HTTPServer -import os -import time - -hostName = "localhost" -serverPort = 8080 - -TEST_BASE_DIR = os.path.abspath( - os.path.join( - os.path.dirname(os.path.abspath(__file__)), - '..' - ) -) - -class MyServer(BaseHTTPRequestHandler): - def do_GET(self): - if self.path == '/google': - return self.get_compute_disks() - self.send_response(200) - self.send_header("Content-type", "text/html") - self.end_headers() - self.wfile.write(bytes("https://pythonbasics.org", "utf-8")) - self.wfile.write(bytes("

Request: %s

" % self.path, "utf-8")) - self.wfile.write(bytes("", "utf-8")) - self.wfile.write(bytes("

This is an example web server.

", "utf-8")) - self.wfile.write(bytes("", "utf-8")) - - def get_compute_disks(self): - with open(os.path.join(TEST_BASE_DIR, 'assets/response/google/compute/disks/disks-list.json'), 'rb') as f: - bt = f.read() - self.send_response(200) - self.send_header("Content-type", "application/json") - self.end_headers() - self.wfile.write(bt) - -if __name__ == "__main__": - webServer = HTTPServer((hostName, serverPort), MyServer) - print("Server started http://%s:%s" % (hostName, serverPort)) - - try: - webServer.serve_forever() - except KeyboardInterrupt: - pass - - webServer.server_close() - print("Server stopped.") diff --git a/test/empty/.gitignore b/test/empty/.gitignore new file mode 100644 index 00000000..c96a04f0 --- /dev/null +++ b/test/empty/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore \ No newline at end of file diff --git a/test/functional/.gitignore b/test/functional/.gitignore new file mode 100644 index 00000000..6b7e6505 --- /dev/null +++ b/test/functional/.gitignore @@ -0,0 +1,7 @@ +.pydevproject +.project +*.pyc +.DS_Store +log.html +output.xml +report.html diff --git a/test/functional/README.md b/test/functional/README.md new file mode 100644 index 00000000..b7e30333 --- /dev/null +++ b/test/functional/README.md @@ -0,0 +1,17 @@ + + +## TODO + +- [ ]Source registry files from other repository, where possible. +- [x]"reuired" string. +- [ ]clean up this readme. +- [ ]integration tests for different registry configurations. + +### Example query executed by the functional tests + +```bash +/Users/admin/stackql/stackql-devel/build/stackql exec "--registry={\"url\": \"file://${HOME}/stackql/stackql-devel/test/registry\", \"localDocRoot\": \"${HOME}/stackql/stackql-devel/test/registry\", \"useEmbedded\": false, \"verifyConfig\": {\"nopVerify\": true}}" "--auth={\"google\": {\"credentialsfilepath\": \"${HOME}/stackql/stackql-devel/test/assets/credentials/dummy/google/functional-test-dummy-sa-key.json\", \"type\": \"service_account\"}, \"okta\": {\"credentialsenvvar\": \"OKTA_SECRET_KEY\", \"type\": \"api_key\"}}" --tls.allowInsecure=true "select ipCidrRange, sum(5) cc from google.container.\`projects.aggregated.usableSubnetworks\` where projectsId = 'testing-project' group by \"ipCidrRange\" having sum(5) >= 5 order by ipCidrRange desc;" + + +/Users/admin/stackql/stackql-devel/build/stackql exec "--registry={\"url\": \"file://${HOME}/stackql/stackql-devel/test/empty\", \"localDocRoot\": \"${HOME}/stackql/stackql-devel/test/empty\", \"useEmbedded\": false, \"verifyConfig\": {\"nopVerify\": true}}" "--auth={\"google\": {\"credentialsfilepath\": \"${HOME}/stackql/stackql-devel/test/assets/credentials/dummy/google/functional-test-dummy-sa-key.json\", \"type\": \"service_account\"}, \"okta\": {\"credentialsenvvar\": \"OKTA_SECRET_KEY\", \"type\": \"api_key\"}}" --tls.allowInsecure=true "show providers;" +``` \ No newline at end of file diff --git a/test/functional/stackql_from_cmd_line.robot b/test/functional/stackql_from_cmd_line.robot new file mode 100644 index 00000000..b19f95be --- /dev/null +++ b/test/functional/stackql_from_cmd_line.robot @@ -0,0 +1,24 @@ +*** Settings *** +Library Process + +*** Settings *** +Variables ${CURDIR}/variables/stackql_context.py + +*** Test Cases *** +Positive Control + Should contain '' '' + +Get Providers + ${result} = Run Process ${STACKQL_EXE} exec \-\-registry\=${REGISTRY_CFG_STR} ${SHOW_PROVIDERS_STR} + Log ${result.stdout} + Should contain ${result.stdout} okta + +Get Okta Services + ${result} = Run Process ${STACKQL_EXE} exec \-\-registry\=${REGISTRY_CFG_STR} ${SHOW_OKTA_SERVICES_FILTERED_STR} + Log ${result.stdout} + Should contain ${result.stdout} Application${SPACE}API + +Get Okta Application Resources + ${result} = Run Process ${STACKQL_EXE} exec \-\-registry\=${REGISTRY_CFG_STR} ${SHOW_OKTA_APPLICATION_RESOURCES_FILTERED_STR} + Log ${result.stdout} + Should contain ${result.stdout} grants groups diff --git a/test/functional/stackql_mocked_from_cmd_line.robot b/test/functional/stackql_mocked_from_cmd_line.robot new file mode 100644 index 00000000..1f31a720 --- /dev/null +++ b/test/functional/stackql_mocked_from_cmd_line.robot @@ -0,0 +1,60 @@ +*** Settings *** +Library Process +Library OperatingSystem + +*** Settings *** +Variables ${CURDIR}/variables/stackql_context.py +Suite Setup Prepare StackQL Environment +Suite Teardown Terminate All Processes + +*** Test Cases *** +Google Container Agg Desc + Should StackQL Exec Equal + ... ${SELECT_CONTAINER_SUBNET_AGG_DESC} + ... ${SELECT_CONTAINER_SUBNET_AGG_DESC_EXPECTED} + +Google Container Agg Asc + Should StackQL Exec Equal + ... ${SELECT_CONTAINER_SUBNET_AGG_ASC} + ... ${SELECT_CONTAINER_SUBNET_AGG_ASC_EXPECTED} + +Google IAM Policy Agg + Should StackQL Exec Equal + ... \-\-infile\=${GET_IAM_POLICY_AGG_ASC_INPUT_FILE} + ... ${GET_IAM_POLICY_AGG_ASC_EXPECTED} + ... \-o\=csv + +*** Keywords *** +Start Mock Server + [Arguments] ${_JSON_INIT_FILE_PATH} ${_MOCKSERVER_JAR} ${_MOCKSERVER_PORT} + ${process} = Start Process java \-Dfile.encoding\=UTF-8 + ... \-Dmockserver.initializationJsonPath\=${_JSON_INIT_FILE_PATH} + ... \-jar ${_MOCKSERVER_JAR} + ... \-serverPort ${_MOCKSERVER_PORT} \-logLevel INFO + Sleep 5s + [Return] ${process} + + +Prepare StackQL Environment + Set Environment Variable OKTA_SECRET_KEY ${OKTA_SECRET_STR} + Start Mock Server ${JSON_INIT_FILE_PATH} ${MOCKSERVER_JAR} 1080 + + +Run StackQL Exec Command + [Arguments] ${_EXEC_CMD_STR} @{varargs} + Set Environment Variable OKTA_SECRET_KEY ${OKTA_SECRET_STR} + ${result} = Run Process + ... ${STACKQL_EXE} + ... exec \-\-registry\=${REGISTRY_CFG_STR} + ... \-\-auth\=${AUTH_CFG_STR} + ... \-\-tls.allowInsecure\=true + ... ${_EXEC_CMD_STR} @{varargs} + Log ${result.stdout} + Log ${result.stderr} + [Return] ${result} + + +Should StackQL Exec Equal + [Arguments] ${_EXEC_CMD_STR} ${_EXEC_CMD_EXPECTED_OUTPUT} @{varargs} + ${result} = Run StackQL Exec Command ${_EXEC_CMD_STR} @{varargs} + Should Be Equal ${result.stdout} ${_EXEC_CMD_EXPECTED_OUTPUT} diff --git a/test/functional/variables/__init__.py b/test/functional/variables/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/test/functional/variables/stackql_context.py b/test/functional/variables/stackql_context.py new file mode 100644 index 00000000..8a64e4f2 --- /dev/null +++ b/test/functional/variables/stackql_context.py @@ -0,0 +1,63 @@ + +import json +import os + +_exe_name = 'stackql' + +if os.name == 'nt': + _exe_name = _exe_name + '.exe' + +REPOSITORY_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', '..', '..')) + +def get_output_from_local_file(fp :str) -> str: + with open(os.path.join(REPOSITORY_ROOT, fp), 'r') as f: + return f.read().strip() + +def get_unix_path(pathStr :str) -> str: + return pathStr.replace('\\', '/') + + +REPOSITORY_ROOT_UNIX = get_unix_path(REPOSITORY_ROOT) +REGISTRY_ROOT = get_unix_path(os.path.join(REPOSITORY_ROOT, 'test', 'registry-mocked')) +STACKQL_EXE = get_unix_path(os.path.join(REPOSITORY_ROOT, 'build', _exe_name)) +_REGISTRY_CFG = { + "url": f"file://{get_unix_path(REGISTRY_ROOT)}", + "localDocRoot": f"{get_unix_path(REGISTRY_ROOT)}", + "useEmbedded": False, + "verifyConfig": { + "nopVerify": True + } +} +_AUTH_CFG={ + "google": { + "credentialsfilepath": get_unix_path(os.path.join(REPOSITORY_ROOT, 'test', 'assets', 'credentials', 'dummy', 'google', 'functional-test-dummy-sa-key.json')), + "type": "service_account" + }, + "okta": { + "credentialsenvvar": "OKTA_SECRET_KEY", + "type": "api_key" + } +} + +with open(os.path.join(REPOSITORY_ROOT, 'test', 'assets', 'credentials', 'dummy', 'okta', 'api-key.txt'), 'r') as f: + OKTA_SECRET_STR = f.read() + +REGISTRY_CFG_STR = json.dumps(_REGISTRY_CFG) +AUTH_CFG_STR = json.dumps(_AUTH_CFG) +SHOW_PROVIDERS_STR = "show providers;" +SHOW_OKTA_SERVICES_FILTERED_STR = "show services from okta like 'app%';" +SHOW_OKTA_APPLICATION_RESOURCES_FILTERED_STR = "show resources from okta.application like 'gr%';" +JSON_INIT_FILE_PATH = os.path.join(REPOSITORY_ROOT, 'test', 'server', 'expectations', 'static-gcp-expectations.json') +MOCKSERVER_JAR = os.path.join(REPOSITORY_ROOT, 'test', 'downloads', 'mockserver-netty-5.12.0-shaded.jar') + + +SELECT_CONTAINER_SUBNET_AGG_DESC = "select ipCidrRange, sum(5) cc from google.container.`projects.aggregated.usableSubnetworks` where projectsId = 'testing-project' group by \"ipCidrRange\" having sum(5) >= 5 order by ipCidrRange desc;" +SELECT_CONTAINER_SUBNET_AGG_ASC = "select ipCidrRange, sum(5) cc from google.container.`projects.aggregated.usableSubnetworks` where projectsId = 'testing-project' group by \"ipCidrRange\" having sum(5) >= 5 order by ipCidrRange asc;" + +SELECT_CONTAINER_SUBNET_AGG_DESC_EXPECTED = get_output_from_local_file(os.path.join('test', 'assets', 'expected', 'aggregated-select', 'google', 'container', 'agg-subnetworks-allowed', 'table', 'simple-count-grouped-variant-desc.txt')) + +SELECT_CONTAINER_SUBNET_AGG_ASC_EXPECTED = get_output_from_local_file(os.path.join('test', 'assets', 'expected', 'aggregated-select', 'google', 'container', 'agg-subnetworks-allowed', 'table', 'simple-count-grouped-variant-asc.txt')) + +GET_IAM_POLICY_AGG_ASC_INPUT_FILE = os.path.join(REPOSITORY_ROOT, 'test', 'assets', 'input', 'select-exec-dependent-org-iam-policy.iql') + +GET_IAM_POLICY_AGG_ASC_EXPECTED = get_output_from_local_file(os.path.join('test', 'assets', 'expected', 'aggregated-select', 'google', 'cloudresourcemanager', 'select-exec-getiampolicy-agg.csv')) \ No newline at end of file diff --git a/test/python/main.py b/test/python/main.py index 019406f5..d866f8ec 100755 --- a/test/python/main.py +++ b/test/python/main.py @@ -25,13 +25,15 @@ class TestStatus(Enum): CURDIR :str = os.path.dirname(os.path.realpath(__file__)) TEST_ROOT_DIR :str = os.path.abspath(os.path.join(CURDIR, '..')) REPOSITORY_ROOT_DIR :str = os.path.abspath(os.path.join(CURDIR, '../..')) +PROVIDER_REGISTRY_ROOT_DIR :str = os.path.abspath(os.path.join(TEST_ROOT_DIR, 'registry')).replace(os.sep, '/') TEST_GENERATOR_DEFINITIONS_ROOT :str = os.path.join(TEST_ROOT_DIR, 'test-generators') TEST_GENERATOR_ALWAYS_ROOT :str = os.path.join(TEST_GENERATOR_DEFINITIONS_ROOT, 'always') TEST_GENERATOR_ASSETS_ROOT :str = os.path.join(TEST_ROOT_DIR, 'assets') DEFAULT_RUN_DIR :str = os.path.abspath(os.path.join(REPOSITORY_ROOT_DIR, 'build')) -DEFAULT_PROVIDER_DIR :str = os.path.abspath(os.path.join(TEST_ROOT_DIR, '.stackql')) -DEFAULT_CONFIG_FILE :str = os.path.abspath(os.path.join(TEST_ROOT_DIR, '.iqlrc')) +DEFAULT_APP_DIR :str = os.path.abspath(os.path.join(TEST_ROOT_DIR, '.stackql')) +DEFAULT_CONFIG_FILE :str = os.path.abspath(os.path.join(TEST_ROOT_DIR, '.stackqlrc')) DEFAULT_DB_FILE :str = os.path.abspath(os.path.join(TEST_ROOT_DIR, 'db/tmp/python-tests-tmp-db.sqlite')) +DEFAULT_REGISTRY_CFG :str = f'{{ "url": "file://{PROVIDER_REGISTRY_ROOT_DIR}", "localDocRoot": "{PROVIDER_REGISTRY_ROOT_DIR}", "useEmbedded": false }}' DEFAULT_EXECUTABLE :str = 'stackql' TEST_COUNT :int = 0 @@ -51,9 +53,9 @@ class TestStatus(Enum): help='directory containing executable' ) parser.add_argument( - '--providerdir', + '--appdir', type=str, - default=DEFAULT_PROVIDER_DIR, + default=DEFAULT_APP_DIR, help='directory containing config and cache' ) parser.add_argument( @@ -104,6 +106,12 @@ class TestStatus(Enum): default=DEFAULT_DB_FILE, help='db file to use as starting point' ) +parser.add_argument( + '--registry', + type=str, + default=DEFAULT_REGISTRY_CFG, + help='registry config' +) args = parser.parse_args() executable_path = f'{args.rundir}/{args.executable}' @@ -112,9 +120,11 @@ class TestStatus(Enum): executable_path, f'--configfile={args.configfile}', '--offline', - f'--providerroot={args.providerdir}', + # '--provider=google', + f'--approot={args.appdir}', f'--loglevel={args.loglevel}', - f'--dbfilepath={args.dbfilepath}' + f'--dbfilepath={args.dbfilepath}', + f'--registry={args.registry}' ] INVOCATION_SIMPLE_ARGS = INVOCATION_BASE_ARGS + [ 'exec' ] @@ -225,7 +235,7 @@ def inner(*args, **kwargs): @test_presentation -def integration_test(*args, **kwargs) -> (TestStatus, Iterable[StringOrBytes], int): +def integration_test(*args, **kwargs) -> Tuple[TestStatus, Iterable[StringOrBytes], int]: try: child = subprocess.Popen([ *args @@ -409,7 +419,7 @@ def simple_test_suite(): '-d=;', '-f={}'.format(_SHOW_EXTENDED_SERVICES_OUTPUT_FILE_ALT_CSV), 'exec', - "show extended services where description like 'Provides natural language%' and version = 'v1'", + "show extended services from google where description like 'Provides natural language%' and version = 'v1'", expected = [ 'id;name;title;description;version;preferred', 'language:v1;.*' ], test_output_file = _SHOW_EXTENDED_SERVICES_OUTPUT_FILE_ALT_CSV, verbose = args.verbosetesting, @@ -434,9 +444,9 @@ def run_integration_test_generator(generator :dict, parent_test_file_path :str, invocation_base_args = copy.deepcopy(INVOCATION_BASE_ARGS) if generator.get("testwitoutapicalls"): invocation_base_args.append(f'--testwitoutapicalls={generator.get("testwitoutapicalls")}') - if generator.get("keyfilepath"): - kp :str = generator.get("keyfilepath") if generator.get("keyfilepath").startswith("/") else os.path.abspath(os.path.join(TEST_GENERATOR_ASSETS_ROOT, generator.get("keyfilepath"))) - invocation_base_args.append(f'--keyfilepath={kp}') + if generator.get("credentialsfilepath"): + kp :str = generator.get("credentialsfilepath") if generator.get("credentialsfilepath").startswith("/") else os.path.abspath(os.path.join(TEST_GENERATOR_ASSETS_ROOT, generator.get("credentialsfilepath"))) + invocation_base_args.append(f'--credentialsfilepath={kp}') if generator.get("iqldata"): idt :str = generator.get("iqldata") if generator.get("iqldata").startswith("/") else os.path.abspath(os.path.join(TEST_GENERATOR_ASSETS_ROOT, generator.get("iqldata"))) invocation_base_args.append(f'--iqldata={idt}') diff --git a/test/python/registry-rewrite.py b/test/python/registry-rewrite.py new file mode 100644 index 00000000..f6ae70fe --- /dev/null +++ b/test/python/registry-rewrite.py @@ -0,0 +1,66 @@ + +import argparse +import os + +from pathlib import Path + +import shutil +import yaml + +CURDIR :str = os.path.dirname(os.path.realpath(__file__)) +TEST_ROOT_DIR :str = os.path.abspath(os.path.join(CURDIR, '..')) +REPOSITORY_ROOT_DIR :str = os.path.abspath(os.path.join(CURDIR, '../..')) + +DEFAULT_SRC_DIR = os.path.join(TEST_ROOT_DIR, 'registry') +DEFAULT_DST_DIR = os.path.join(TEST_ROOT_DIR, 'registry-mocked') +DEFAULT_PORT = 1080 + + + +parser = argparse.ArgumentParser(description='Process some test config.') +parser.add_argument( + '--srcdir', + type=str, + default=DEFAULT_SRC_DIR, + help='directory containing executable' +) +parser.add_argument( + '--destdir', + type=str, + default=DEFAULT_DST_DIR, + help='directory containing config and cache' +) +parser.add_argument( + '--port', + type=int, + default=DEFAULT_PORT, + help='directory containing config and cache' +) + +def main(args): + os.chdir(args.srcdir) + for r, dz, fz in os.walk('.'): + for d in dz: + Path(os.path.join(os.path.abspath(args.destdir), r, d)).mkdir(parents=True, exist_ok=True) + for f in fz: + if f.endswith('.yaml'): + with open(os.path.join(r, f)) as fr: + d = yaml.safe_load(fr) + servs = d.get('servers', []) + for srv in servs: + srv['url'] = f'https://localhost:{args.port}/' + d['servers'] = servs + with open(os.path.join(os.path.abspath(args.destdir), r, f), 'w') as fw: + yaml.dump(d, fw) + else: + shutil.copy( + os.path.join(os.path.abspath(args.srcdir), r, f), + os.path.join(os.path.abspath(args.destdir), r, f) + ) + + + + +if __name__ == '__main__': + args = parser.parse_args() + main(args) diff --git a/test/registry-mocked/.gitignore b/test/registry-mocked/.gitignore new file mode 100644 index 00000000..c96a04f0 --- /dev/null +++ b/test/registry-mocked/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore \ No newline at end of file diff --git a/test/registry/src/googleapis.com/v1/provider.yaml b/test/registry/src/googleapis.com/v1/provider.yaml new file mode 100644 index 00000000..465368a8 --- /dev/null +++ b/test/registry/src/googleapis.com/v1/provider.yaml @@ -0,0 +1,4376 @@ +id: google +name: google +providerServices: + abusiveexperiencereport: + description: Views Abusive Experience Report data, and gets a list of sites that + have a significant number of abusive experiences. + discoveryRestUrl: https://abusiveexperiencereport.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/abusive-experience-report/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: abusiveexperiencereport:v1 + kind: discovery#directoryItem + name: abusiveexperiencereport + preferred: true + service: + $ref: googleapis.com/v1/services/abusiveexperiencereport-v1.yaml + title: Abusive Experience Report API + version: v1 + acceleratedmobilepageurl: + description: Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for + a given list of public URL(s). + discoveryRestUrl: https://acceleratedmobilepageurl.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/amp/cache/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: acceleratedmobilepageurl:v1 + kind: discovery#directoryItem + name: acceleratedmobilepageurl + preferred: true + service: + $ref: googleapis.com/v1/services/acceleratedmobilepageurl-v1.yaml + title: Accelerated Mobile Pages (AMP) URL API + version: v1 + accessapproval: + description: An API for controlling access to data by Google personnel. + discoveryRestUrl: https://accessapproval.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/access-approval/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: accessapproval:v1 + kind: discovery#directoryItem + name: accessapproval + preferred: true + service: + $ref: googleapis.com/v1/services/accessapproval-v1.yaml + title: Access Approval API + version: v1 + accessapproval:v1beta1: + description: An API for controlling access to data by Google personnel. + discoveryRestUrl: https://accessapproval.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/access-approval/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: accessapproval:v1beta1 + kind: discovery#directoryItem + name: accessapproval + preferred: false + title: Access Approval API + version: v1beta1 + accesscontextmanager: + description: An API for setting attribute based access control to requests to + GCP services. + discoveryRestUrl: https://accesscontextmanager.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/access-context-manager/docs/reference/rest/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: accesscontextmanager:v1 + kind: discovery#directoryItem + name: accesscontextmanager + preferred: true + service: + $ref: googleapis.com/v1/services/accesscontextmanager-v1.yaml + title: Access Context Manager API + version: v1 + accesscontextmanager:v1beta: + description: An API for setting attribute based access control to requests to + GCP services. + discoveryRestUrl: https://accesscontextmanager.googleapis.com/services/$discovery-rest?version=v1beta + documentationLink: https://cloud.google.com/access-context-manager/docs/reference/rest/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: accesscontextmanager:v1beta + kind: discovery#directoryItem + name: accesscontextmanager + preferred: false + title: Access Context Manager API + version: v1beta + adexchangebuyer: + description: Accesses your bidding-account information, submits creatives for + validation, finds available direct deals, and retrieves performance reports. + discoveryLink: ./apis/adexchangebuyer/v1.4/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/adexchangebuyer/v1.4-rest + documentationLink: https://developers.google.com/ad-exchange/buyer-rest + icons: + x16: https://www.google.com/images/icons/product/doubleclick-16.gif + x32: https://www.google.com/images/icons/product/doubleclick-32.gif + id: adexchangebuyer:v1.4 + kind: discovery#directoryItem + name: adexchangebuyer + preferred: true + service: + $ref: googleapis.com/v1/services/adexchangebuyer-v1.4.yaml + title: Ad Exchange Buyer API + version: v1.4 + adexchangebuyer2: + description: Accesses the latest features for managing Authorized Buyers accounts, + Real-Time Bidding configurations and auction metrics, and Marketplace programmatic + deals. + discoveryRestUrl: https://adexchangebuyer.googleapis.com/services/$discovery-rest?version=v2beta1 + documentationLink: https://developers.google.com/authorized-buyers/apis/reference/rest/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: adexchangebuyer2:v2beta1 + kind: discovery#directoryItem + name: adexchangebuyer2 + preferred: true + service: + $ref: googleapis.com/v1/services/adexchangebuyer2-v2beta1.yaml + title: Ad Exchange Buyer API II + version: v2beta1 + adexchangebuyer:v1.2: + description: Accesses your bidding-account information, submits creatives for + validation, finds available direct deals, and retrieves performance reports. + discoveryLink: ./apis/adexchangebuyer/v1.2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/adexchangebuyer/v1.2-rest + documentationLink: https://developers.google.com/ad-exchange/buyer-rest + icons: + x16: https://www.google.com/images/icons/product/doubleclick-16.gif + x32: https://www.google.com/images/icons/product/doubleclick-32.gif + id: adexchangebuyer:v1.2 + kind: discovery#directoryItem + name: adexchangebuyer + preferred: false + title: Ad Exchange Buyer API + version: v1.2 + adexchangebuyer:v1.3: + description: Accesses your bidding-account information, submits creatives for + validation, finds available direct deals, and retrieves performance reports. + discoveryLink: ./apis/adexchangebuyer/v1.3/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/adexchangebuyer/v1.3-rest + documentationLink: https://developers.google.com/ad-exchange/buyer-rest + icons: + x16: https://www.google.com/images/icons/product/doubleclick-16.gif + x32: https://www.google.com/images/icons/product/doubleclick-32.gif + id: adexchangebuyer:v1.3 + kind: discovery#directoryItem + name: adexchangebuyer + preferred: false + title: Ad Exchange Buyer API + version: v1.3 + adexperiencereport: + description: Views Ad Experience Report data, and gets a list of sites that have + a significant number of annoying ads. + discoveryRestUrl: https://adexperiencereport.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/ad-experience-report/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: adexperiencereport:v1 + kind: discovery#directoryItem + name: adexperiencereport + preferred: true + service: + $ref: googleapis.com/v1/services/adexperiencereport-v1.yaml + title: Ad Experience Report API + version: v1 + admin: + description: Fetches reports for the administrators of G Suite customers about + the usage, collaboration, security, and risk for their users. + discoveryLink: ./apis/admin/reports_v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/admin/reports_v1-rest + documentationLink: /admin-sdk/reports/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: admin:reports_v1 + kind: discovery#directoryItem + name: admin + preferred: true + service: + $ref: googleapis.com/v1/services/admin-reports_v1.yaml + title: Admin Reports API + version: reports_v1 + admin:datatransfer_v1: + description: Transfers user data from one user to another. + discoveryLink: ./apis/admin/datatransfer_v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/admin/datatransfer_v1-rest + documentationLink: https://developers.google.com/admin-sdk/data-transfer/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: admin:datatransfer_v1 + kind: discovery#directoryItem + name: admin + preferred: false + title: Admin Data Transfer API + version: datatransfer_v1 + admin:directory_v1: + description: Manages enterprise resources such as users and groups, administrative + notifications, security features, and more. + discoveryLink: ./apis/admin/directory_v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/admin/directory_v1-rest + documentationLink: https://developers.google.com/admin-sdk/directory/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: admin:directory_v1 + kind: discovery#directoryItem + name: admin + preferred: false + title: Admin Directory API + version: directory_v1 + admob: + description: The Google AdMob API lets you programmatically get reports on earnings. + discoveryRestUrl: https://admob.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/admob/api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: admob:v1 + kind: discovery#directoryItem + name: admob + preferred: true + service: + $ref: googleapis.com/v1/services/admob-v1.yaml + title: AdMob API + version: v1 + adsense: + description: The AdSense Management API allows publishers to access their inventory + and run earnings and performance reports. + discoveryRestUrl: https://adsense.googleapis.com/services/$discovery-rest?version=v1.4 + documentationLink: http://code.google.com/apis/adsense/management/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: adsense:v1.4 + kind: discovery#directoryItem + name: adsense + preferred: true + service: + $ref: googleapis.com/v1/services/adsense-v1.4.yaml + title: AdSense Management API + version: v1.4 + adsensehost: + description: The AdSense Host API gives AdSense Hosts access to report generation, + ad code generation, and publisher management capabilities. + discoveryRestUrl: https://adsensehost.googleapis.com/services/$discovery-rest?version=v4.1 + documentationLink: https://developers.google.com/adsense/host/index + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: adsensehost:v4.1 + kind: discovery#directoryItem + name: adsensehost + preferred: true + service: + $ref: googleapis.com/v1/services/adsensehost-v4.1.yaml + title: AdSense Host API + version: v4.1 + alertcenter: + description: Manages alerts on issues affecting your domain. + discoveryRestUrl: https://alertcenter.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://developers.google.com/admin-sdk/alertcenter/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: alertcenter:v1beta1 + kind: discovery#directoryItem + name: alertcenter + preferred: true + service: + $ref: googleapis.com/v1/services/alertcenter-v1beta1.yaml + title: G Suite Alert Center API + version: v1beta1 + analytics: + description: Views and manages your Google Analytics data. + discoveryLink: ./apis/analytics/v3/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/analytics/v3-rest + documentationLink: https://developers.google.com/analytics/ + icons: + x16: https://www.google.com/images/icons/product/analytics-16.png + x32: https://www.google.com/images/icons/product/analytics-32.png + id: analytics:v3 + kind: discovery#directoryItem + name: analytics + preferred: true + service: + $ref: googleapis.com/v1/services/analytics-v3.yaml + title: Google Analytics API + version: v3 + analyticsreporting: + description: Accesses Analytics report data. + discoveryRestUrl: https://analyticsreporting.googleapis.com/services/$discovery-rest?version=v4 + documentationLink: https://developers.google.com/analytics/devguides/reporting/core/v4/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: analyticsreporting:v4 + kind: discovery#directoryItem + name: analyticsreporting + preferred: true + service: + $ref: googleapis.com/v1/services/analyticsreporting-v4.yaml + title: Analytics Reporting API + version: v4 + androiddeviceprovisioning: + description: Automates Android zero-touch enrollment for device resellers, customers, + and EMMs. + discoveryRestUrl: https://androiddeviceprovisioning.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/zero-touch/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: androiddeviceprovisioning:v1 + kind: discovery#directoryItem + name: androiddeviceprovisioning + preferred: true + service: + $ref: googleapis.com/v1/services/androiddeviceprovisioning-v1.yaml + title: Android Device Provisioning Partner API + version: v1 + androidenterprise: + description: Manages the deployment of apps to Android for Work users. + discoveryLink: ./apis/androidenterprise/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/androidenterprise/v1-rest + documentationLink: https://developers.google.com/android/work/play/emm-api + icons: + x16: https://www.google.com/images/icons/product/android-16.png + x32: https://www.google.com/images/icons/product/android-32.png + id: androidenterprise:v1 + kind: discovery#directoryItem + name: androidenterprise + preferred: true + service: + $ref: googleapis.com/v1/services/androidenterprise-v1.yaml + title: Google Play EMM API + version: v1 + androidmanagement: + description: The Android Management API provides remote enterprise management + of Android devices and apps. + discoveryRestUrl: https://androidmanagement.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/android/management + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: androidmanagement:v1 + kind: discovery#directoryItem + name: androidmanagement + preferred: true + service: + $ref: googleapis.com/v1/services/androidmanagement-v1.yaml + title: Android Management API + version: v1 + androidpublisher: + description: Accesses Android application developers' Google Play accounts. + discoveryLink: ./apis/androidpublisher/v3/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/androidpublisher/v3-rest + documentationLink: https://developers.google.com/android-publisher + icons: + x16: https://www.google.com/images/icons/product/android-16.png + x32: https://www.google.com/images/icons/product/android-32.png + id: androidpublisher:v3 + kind: discovery#directoryItem + name: androidpublisher + preferred: true + service: + $ref: googleapis.com/v1/services/androidpublisher-v3.yaml + title: Google Play Developer API + version: v3 + apigee: + description: 'The Apigee API lets you programmatically manage Apigee hybrid with + a set of RESTful operations, including: - Create, edit, and delete API proxies + - Manage users - Deploy and undeploy proxy revisions - Configure environments + For information on using the APIs described in this section, see Get started + using the APIs . *Note:* This + product is available as a free trial for a time period of 60 days.' + discoveryRestUrl: https://apigee.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/apigee-api-management/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: apigee:v1 + kind: discovery#directoryItem + name: apigee + preferred: true + service: + $ref: googleapis.com/v1/services/apigee-v1.yaml + title: Apigee API + version: v1 + appengine: + description: Provisions and manages developers' App Engine applications. + discoveryRestUrl: https://appengine.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/appengine/docs/admin-api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: appengine:v1 + kind: discovery#directoryItem + name: appengine + preferred: true + service: + $ref: googleapis.com/v1/services/appengine-v1.yaml + title: App Engine Admin API + version: v1 + appengine:v1alpha: + description: Provisions and manages developers' App Engine applications. + discoveryRestUrl: https://appengine.googleapis.com/services/$discovery-rest?version=v1alpha + documentationLink: https://cloud.google.com/appengine/docs/admin-api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: appengine:v1alpha + kind: discovery#directoryItem + name: appengine + preferred: false + title: App Engine Admin API + version: v1alpha + appengine:v1beta: + description: Provisions and manages developers' App Engine applications. + discoveryRestUrl: https://appengine.googleapis.com/services/$discovery-rest?version=v1beta + documentationLink: https://cloud.google.com/appengine/docs/admin-api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: appengine:v1beta + kind: discovery#directoryItem + name: appengine + preferred: false + title: App Engine Admin API + version: v1beta + appengine:v1beta4: + description: Provisions and manages developers' App Engine applications. + discoveryRestUrl: https://appengine.googleapis.com/services/$discovery-rest?version=v1beta4 + documentationLink: https://cloud.google.com/appengine/docs/admin-api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: appengine:v1beta4 + kind: discovery#directoryItem + name: appengine + preferred: false + title: App Engine Admin API + version: v1beta4 + appengine:v1beta5: + description: Provisions and manages developers' App Engine applications. + discoveryRestUrl: https://appengine.googleapis.com/services/$discovery-rest?version=v1beta5 + documentationLink: https://cloud.google.com/appengine/docs/admin-api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: appengine:v1beta5 + kind: discovery#directoryItem + name: appengine + preferred: false + title: App Engine Admin API + version: v1beta5 + appsactivity: + description: Provides a historical view of activity. + discoveryLink: ./apis/appsactivity/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/appsactivity/v1-rest + documentationLink: https://developers.google.com/google-apps/activity/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: appsactivity:v1 + kind: discovery#directoryItem + name: appsactivity + preferred: true + service: + $ref: googleapis.com/v1/services/appsactivity-v1.yaml + title: Drive Activity API + version: v1 + artifactregistry: + description: Store and manage build artifacts in a scalable and integrated service + built on Google infrastructure. + discoveryRestUrl: https://artifactregistry.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/artifacts/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: artifactregistry:v1beta1 + kind: discovery#directoryItem + name: artifactregistry + preferred: true + service: + $ref: googleapis.com/v1/services/artifactregistry-v1beta1.yaml + title: Artifact Registry API + version: v1beta1 + bigquery: + description: A data platform for customers to create, manage, share and query + data. + discoveryLink: ./apis/bigquery/v2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/bigquery/v2-rest + documentationLink: https://cloud.google.com/bigquery/ + icons: + x16: https://www.google.com/images/icons/product/search-16.gif + x32: https://www.google.com/images/icons/product/search-32.gif + id: bigquery:v2 + kind: discovery#directoryItem + name: bigquery + preferred: true + service: + $ref: googleapis.com/v1/services/bigquery-v2.yaml + title: BigQuery API + version: v2 + bigqueryconnection: + description: Allows users to manage BigQuery connections to external data sources. + discoveryRestUrl: https://bigqueryconnection.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/bigquery/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: bigqueryconnection:v1beta1 + kind: discovery#directoryItem + name: bigqueryconnection + preferred: true + service: + $ref: googleapis.com/v1/services/bigqueryconnection-v1beta1.yaml + title: BigQuery Connection API + version: v1beta1 + bigquerydatatransfer: + description: Schedule queries or transfer external data from SaaS applications + to Google BigQuery on a regular basis. + discoveryRestUrl: https://bigquerydatatransfer.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/bigquery/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: bigquerydatatransfer:v1 + kind: discovery#directoryItem + name: bigquerydatatransfer + preferred: true + service: + $ref: googleapis.com/v1/services/bigquerydatatransfer-v1.yaml + title: BigQuery Data Transfer API + version: v1 + bigqueryreservation: + description: A service to modify your BigQuery flat-rate reservations. + discoveryRestUrl: https://bigqueryreservation.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/bigquery/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: bigqueryreservation:v1 + kind: discovery#directoryItem + name: bigqueryreservation + preferred: true + service: + $ref: googleapis.com/v1/services/bigqueryreservation-v1.yaml + title: BigQuery Reservation API + version: v1 + bigqueryreservation:v1alpha2: + description: A service to modify your BigQuery flat-rate reservations. + discoveryRestUrl: https://bigqueryreservation.googleapis.com/services/$discovery-rest?version=v1alpha2 + documentationLink: https://cloud.google.com/bigquery/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: bigqueryreservation:v1alpha2 + kind: discovery#directoryItem + name: bigqueryreservation + preferred: false + title: BigQuery Reservation API + version: v1alpha2 + bigqueryreservation:v1beta1: + description: A service to modify your BigQuery flat-rate reservations. + discoveryRestUrl: https://bigqueryreservation.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/bigquery/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: bigqueryreservation:v1beta1 + kind: discovery#directoryItem + name: bigqueryreservation + preferred: false + title: BigQuery Reservation API + version: v1beta1 + bigtableadmin: + description: Administer your Cloud Bigtable tables and instances. + discoveryRestUrl: https://bigtableadmin.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/bigtable/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: bigtableadmin:v2 + kind: discovery#directoryItem + name: bigtableadmin + preferred: true + service: + $ref: googleapis.com/v1/services/bigtableadmin-v2.yaml + title: Cloud Bigtable Admin API + version: v2 + bigtableadmin:v1: + description: Administer your Cloud Bigtable tables and instances. + discoveryRestUrl: https://bigtableadmin.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/bigtable/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: bigtableadmin:v1 + kind: discovery#directoryItem + name: bigtableadmin + preferred: false + title: Cloud Bigtable Admin API + version: v1 + billingbudgets: + description: The Cloud Billing Budget API stores Cloud Billing budgets, which + define a budget plan and the rules to execute as spend is tracked against that + plan. + discoveryRestUrl: https://billingbudgets.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/billing/docs/how-to/budget-api-overview + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: billingbudgets:v1beta1 + kind: discovery#directoryItem + name: billingbudgets + preferred: true + service: + $ref: googleapis.com/v1/services/billingbudgets-v1beta1.yaml + title: Cloud Billing Budget API + version: v1beta1 + binaryauthorization: + description: The management interface for Binary Authorization, a system providing + policy control for images deployed to Kubernetes Engine clusters. + discoveryRestUrl: https://binaryauthorization.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/binary-authorization/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: binaryauthorization:v1 + kind: discovery#directoryItem + name: binaryauthorization + preferred: true + service: + $ref: googleapis.com/v1/services/binaryauthorization-v1.yaml + title: Binary Authorization API + version: v1 + binaryauthorization:v1beta1: + description: The management interface for Binary Authorization, a system providing + policy control for images deployed to Kubernetes Engine clusters. + discoveryRestUrl: https://binaryauthorization.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/binary-authorization/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: binaryauthorization:v1beta1 + kind: discovery#directoryItem + name: binaryauthorization + preferred: false + title: Binary Authorization API + version: v1beta1 + blogger: + description: The Blogger API provides access to posts, comments and pages of a + Blogger blog. + discoveryRestUrl: https://blogger.googleapis.com/services/$discovery-rest?version=v3 + documentationLink: https://developers.google.com/blogger/docs/3.0/getting_started + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: blogger:v3 + kind: discovery#directoryItem + name: blogger + preferred: true + service: + $ref: googleapis.com/v1/services/blogger-v3.yaml + title: Blogger API v3 + version: v3 + blogger:v2: + description: The Blogger API provides access to posts, comments and pages of a + Blogger blog. + discoveryRestUrl: https://blogger.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://developers.google.com/blogger/docs/3.0/getting_started + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: blogger:v2 + kind: discovery#directoryItem + name: blogger + preferred: false + title: Blogger API v3 + version: v2 + books: + description: Searches for books and manages your Google Books library. + discoveryLink: ./apis/books/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/books/v1-rest + documentationLink: https://developers.google.com/books/docs/v1/getting_started + icons: + x16: https://www.google.com/images/icons/product/ebooks-16.png + x32: https://www.google.com/images/icons/product/ebooks-32.png + id: books:v1 + kind: discovery#directoryItem + name: books + preferred: true + service: + $ref: googleapis.com/v1/services/books-v1.yaml + title: Books API + version: v1 + calendar: + description: Manipulates events and other calendar data. + discoveryLink: ./apis/calendar/v3/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/calendar/v3-rest + documentationLink: https://developers.google.com/google-apps/calendar/firstapp + icons: + x16: http://www.google.com/images/icons/product/calendar-16.png + x32: http://www.google.com/images/icons/product/calendar-32.png + id: calendar:v3 + kind: discovery#directoryItem + name: calendar + preferred: true + service: + $ref: googleapis.com/v1/services/calendar-v3.yaml + title: Calendar API + version: v3 + chat: + description: Enables bots to fetch information and perform actions in Hangouts + Chat. + discoveryRestUrl: https://chat.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/hangouts/chat + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: chat:v1 + kind: discovery#directoryItem + name: chat + preferred: true + service: + $ref: googleapis.com/v1/services/chat-v1.yaml + title: Hangouts Chat API + version: v1 + chromeuxreport: + description: The Chrome UX Report API lets you view real user experience data + for millions of websites. + discoveryRestUrl: https://chromeuxreport.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/web/tools/chrome-user-experience-report/api/reference + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: chromeuxreport:v1 + kind: discovery#directoryItem + name: chromeuxreport + preferred: true + service: + $ref: googleapis.com/v1/services/chromeuxreport-v1.yaml + title: Chrome UX Report API + version: v1 + civicinfo: + description: Provides polling places, early vote locations, contest data, election + officials, and government representatives for U.S. residential addresses. + discoveryRestUrl: https://civicinfo.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://developers.google.com/civic-information/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: civicinfo:v2 + kind: discovery#directoryItem + name: civicinfo + preferred: true + service: + $ref: googleapis.com/v1/services/civicinfo-v2.yaml + title: Google Civic Information API + version: v2 + classroom: + description: Manages classes, rosters, and invitations in Google Classroom. + discoveryRestUrl: https://classroom.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/classroom + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: classroom:v1 + kind: discovery#directoryItem + name: classroom + preferred: true + service: + $ref: googleapis.com/v1/services/classroom-v1.yaml + title: Google Classroom API + version: v1 + cloudasset: + description: The cloud asset API manages the history and inventory of cloud resources. + discoveryRestUrl: https://cloudasset.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/asset-inventory/docs/quickstart + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudasset:v1 + kind: discovery#directoryItem + name: cloudasset + preferred: true + service: + $ref: googleapis.com/v1/services/cloudasset-v1.yaml + title: Cloud Asset API + version: v1 + cloudasset:v1beta1: + description: The cloud asset API manages the history and inventory of cloud resources. + discoveryRestUrl: https://cloudasset.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/asset-inventory/docs/quickstart + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudasset:v1beta1 + kind: discovery#directoryItem + name: cloudasset + preferred: false + title: Cloud Asset API + version: v1beta1 + cloudasset:v1p1beta1: + description: The cloud asset API manages the history and inventory of cloud resources. + discoveryRestUrl: https://cloudasset.googleapis.com/services/$discovery-rest?version=v1p1beta1 + documentationLink: https://cloud.google.com/asset-inventory/docs/quickstart + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudasset:v1p1beta1 + kind: discovery#directoryItem + name: cloudasset + preferred: false + title: Cloud Asset API + version: v1p1beta1 + cloudasset:v1p4beta1: + description: The cloud asset API manages the history and inventory of cloud resources. + discoveryRestUrl: https://cloudasset.googleapis.com/services/$discovery-rest?version=v1p4beta1 + documentationLink: https://cloud.google.com/asset-inventory/docs/quickstart + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudasset:v1p4beta1 + kind: discovery#directoryItem + name: cloudasset + preferred: false + title: Cloud Asset API + version: v1p4beta1 + cloudasset:v1p5beta1: + description: The cloud asset API manages the history and inventory of cloud resources. + discoveryRestUrl: https://cloudasset.googleapis.com/services/$discovery-rest?version=v1p5beta1 + documentationLink: https://cloud.google.com/asset-inventory/docs/quickstart + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudasset:v1p5beta1 + kind: discovery#directoryItem + name: cloudasset + preferred: false + title: Cloud Asset API + version: v1p5beta1 + cloudbilling: + description: Allows developers to manage billing for their Google Cloud Platform + projects programmatically. + discoveryRestUrl: https://cloudbilling.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/billing/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudbilling:v1 + kind: discovery#directoryItem + name: cloudbilling + preferred: true + service: + $ref: googleapis.com/v1/services/cloudbilling-v1.yaml + title: Cloud Billing API + version: v1 + cloudbuild: + description: Creates and manages builds on Google Cloud Platform. + discoveryRestUrl: https://cloudbuild.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/cloud-build/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudbuild:v1 + kind: discovery#directoryItem + name: cloudbuild + preferred: true + service: + $ref: googleapis.com/v1/services/cloudbuild-v1.yaml + title: Cloud Build API + version: v1 + cloudbuild:v1alpha1: + description: Creates and manages builds on Google Cloud Platform. + discoveryRestUrl: https://cloudbuild.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://cloud.google.com/cloud-build/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudbuild:v1alpha1 + kind: discovery#directoryItem + name: cloudbuild + preferred: false + title: Cloud Build API + version: v1alpha1 + cloudbuild:v1alpha2: + description: Creates and manages builds on Google Cloud Platform. + discoveryRestUrl: https://cloudbuild.googleapis.com/services/$discovery-rest?version=v1alpha2 + documentationLink: https://cloud.google.com/cloud-build/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudbuild:v1alpha2 + kind: discovery#directoryItem + name: cloudbuild + preferred: false + title: Cloud Build API + version: v1alpha2 + clouddebugger: + description: Examines the call stack and variables of a running application without + stopping or slowing it down. + discoveryRestUrl: https://clouddebugger.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/debugger + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: clouddebugger:v2 + kind: discovery#directoryItem + name: clouddebugger + preferred: true + service: + $ref: googleapis.com/v1/services/clouddebugger-v2.yaml + title: Cloud Debugger API + version: v2 + clouderrorreporting: + description: Groups and counts similar errors from cloud services and applications, + reports new errors, and provides access to error groups and their associated + errors. + discoveryRestUrl: https://clouderrorreporting.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/error-reporting/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: clouderrorreporting:v1beta1 + kind: discovery#directoryItem + name: clouderrorreporting + preferred: true + service: + $ref: googleapis.com/v1/services/clouderrorreporting-v1beta1.yaml + title: Error Reporting API + version: v1beta1 + cloudfunctions: + description: Manages lightweight user-provided functions executed in response + to events. + discoveryRestUrl: https://cloudfunctions.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/functions + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudfunctions:v1 + kind: discovery#directoryItem + name: cloudfunctions + preferred: true + service: + $ref: googleapis.com/v1/services/cloudfunctions-v1.yaml + title: Cloud Functions API + version: v1 + cloudidentity: + description: API for provisioning and managing identity resources. + discoveryRestUrl: https://cloudidentity.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/identity/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudidentity:v1 + kind: discovery#directoryItem + name: cloudidentity + preferred: true + service: + $ref: googleapis.com/v1/services/cloudidentity-v1.yaml + title: Cloud Identity API + version: v1 + cloudidentity:v1beta1: + description: API for provisioning and managing identity resources. + discoveryRestUrl: https://cloudidentity.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/identity/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudidentity:v1beta1 + kind: discovery#directoryItem + name: cloudidentity + preferred: false + title: Cloud Identity API + version: v1beta1 + cloudiot: + description: Registers and manages IoT (Internet of Things) devices that connect + to the Google Cloud Platform. + discoveryRestUrl: https://cloudiot.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/iot + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudiot:v1 + kind: discovery#directoryItem + name: cloudiot + preferred: true + service: + $ref: googleapis.com/v1/services/cloudiot-v1.yaml + title: Cloud IoT API + version: v1 + cloudiot:v1alpha1: + description: Registers and manages IoT (Internet of Things) devices that connect + to the Google Cloud Platform. + discoveryRestUrl: https://cloudiot.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://cloud.google.com/iot + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudiot:v1alpha1 + kind: discovery#directoryItem + name: cloudiot + preferred: false + title: Cloud IoT API + version: v1alpha1 + cloudkms: + description: Manages keys and performs cryptographic operations in a central cloud + service, for direct use by other cloud resources and applications. + discoveryRestUrl: https://cloudkms.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/kms/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudkms:v1 + kind: discovery#directoryItem + name: cloudkms + preferred: true + service: + $ref: googleapis.com/v1/services/cloudkms-v1.yaml + title: Cloud Key Management Service (KMS) API + version: v1 + cloudprofiler: + description: Manages continuous profiling information. + discoveryRestUrl: https://cloudprofiler.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/profiler/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudprofiler:v2 + kind: discovery#directoryItem + name: cloudprofiler + preferred: true + service: + $ref: googleapis.com/v1/services/cloudprofiler-v2.yaml + title: Stackdriver Profiler API + version: v2 + cloudresourcemanager:v2: + description: Creates, reads, and updates metadata for Google Cloud Platform resource + containers. + discoveryRestUrl: https://cloudresourcemanager.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/resource-manager + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudresourcemanager:v2 + kind: discovery#directoryItem + name: cloudresourcemanager + preferred: false + service: + $ref: googleapis.com/v1/services/cloudresourcemanager-v2.yaml + title: Cloud Resource Manager API + version: v2 + cloudresourcemanager: + description: Creates, reads, and updates metadata for Google Cloud Platform resource + containers. + discoveryRestUrl: https://cloudresourcemanager.googleapis.com/services/$discovery-rest?version=v3 + documentationLink: https://cloud.google.com/resource-manager + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudresourcemanager:v3 + kind: discovery#directoryItem + name: cloudresourcemanager + preferred: true + service: + $ref: googleapis.com/v1/services/cloudresourcemanager-v3.yaml + title: Cloud Resource Manager API + version: v3 + cloudresourcemanager:v1: + description: Creates, reads, and updates metadata for Google Cloud Platform resource + containers. + discoveryRestUrl: https://cloudresourcemanager.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/resource-manager + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudresourcemanager:v1 + kind: discovery#directoryItem + name: cloudresourcemanager + preferred: false + title: Cloud Resource Manager API + version: v1 + cloudresourcemanager:v1beta1: + description: Creates, reads, and updates metadata for Google Cloud Platform resource + containers. + discoveryRestUrl: https://cloudresourcemanager.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/resource-manager + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudresourcemanager:v1beta1 + kind: discovery#directoryItem + name: cloudresourcemanager + preferred: false + title: Cloud Resource Manager API + version: v1beta1 + cloudresourcemanager:v2beta1: + description: Creates, reads, and updates metadata for Google Cloud Platform resource + containers. + discoveryRestUrl: https://cloudresourcemanager.googleapis.com/services/$discovery-rest?version=v2beta1 + documentationLink: https://cloud.google.com/resource-manager + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudresourcemanager:v2beta1 + kind: discovery#directoryItem + name: cloudresourcemanager + preferred: false + title: Cloud Resource Manager API + version: v2beta1 + cloudscheduler: + description: Creates and manages jobs run on a regular recurring schedule. + discoveryRestUrl: https://cloudscheduler.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/scheduler/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudscheduler:v1 + kind: discovery#directoryItem + name: cloudscheduler + preferred: true + service: + $ref: googleapis.com/v1/services/cloudscheduler-v1.yaml + title: Cloud Scheduler API + version: v1 + cloudscheduler:v1beta1: + description: Creates and manages jobs run on a regular recurring schedule. + discoveryRestUrl: https://cloudscheduler.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/scheduler/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudscheduler:v1beta1 + kind: discovery#directoryItem + name: cloudscheduler + preferred: false + title: Cloud Scheduler API + version: v1beta1 + cloudsearch: + description: Cloud Search provides cloud-based search capabilities over G Suite + data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search. + discoveryRestUrl: https://cloudsearch.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/cloud-search/docs/guides/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudsearch:v1 + kind: discovery#directoryItem + name: cloudsearch + preferred: true + service: + $ref: googleapis.com/v1/services/cloudsearch-v1.yaml + title: Cloud Search API + version: v1 + cloudshell: + description: Allows users to start, configure, and connect to interactive shell + sessions running in the cloud. + discoveryRestUrl: https://cloudshell.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/shell/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudshell:v1 + kind: discovery#directoryItem + name: cloudshell + preferred: true + service: + $ref: googleapis.com/v1/services/cloudshell-v1.yaml + title: Cloud Shell API + version: v1 + cloudshell:v1alpha1: + description: Allows users to start, configure, and connect to interactive shell + sessions running in the cloud. + discoveryRestUrl: https://cloudshell.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://cloud.google.com/shell/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudshell:v1alpha1 + kind: discovery#directoryItem + name: cloudshell + preferred: false + title: Cloud Shell API + version: v1alpha1 + cloudtasks: + description: Manages the execution of large numbers of distributed requests. + discoveryRestUrl: https://cloudtasks.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/tasks/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudtasks:v2 + kind: discovery#directoryItem + name: cloudtasks + preferred: true + service: + $ref: googleapis.com/v1/services/cloudtasks-v2.yaml + title: Cloud Tasks API + version: v2 + cloudtasks:v2beta2: + description: Manages the execution of large numbers of distributed requests. + discoveryRestUrl: https://cloudtasks.googleapis.com/services/$discovery-rest?version=v2beta2 + documentationLink: https://cloud.google.com/tasks/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudtasks:v2beta2 + kind: discovery#directoryItem + name: cloudtasks + preferred: false + title: Cloud Tasks API + version: v2beta2 + cloudtasks:v2beta3: + description: Manages the execution of large numbers of distributed requests. + discoveryRestUrl: https://cloudtasks.googleapis.com/services/$discovery-rest?version=v2beta3 + documentationLink: https://cloud.google.com/tasks/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudtasks:v2beta3 + kind: discovery#directoryItem + name: cloudtasks + preferred: false + title: Cloud Tasks API + version: v2beta3 + cloudtrace: + description: Sends application trace data to Cloud Trace for viewing. Trace data + is collected for all App Engine applications by default. Trace data from other + applications can be provided using this API. This library is used to interact + with the Cloud Trace API directly. If you are looking to instrument your application + for Cloud Trace, we recommend using OpenCensus. + discoveryRestUrl: https://cloudtrace.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/trace + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudtrace:v2 + kind: discovery#directoryItem + name: cloudtrace + preferred: true + service: + $ref: googleapis.com/v1/services/cloudtrace-v2.yaml + title: Cloud Trace API + version: v2 + cloudtrace:v1: + description: Sends application trace data to Cloud Trace for viewing. Trace data + is collected for all App Engine applications by default. Trace data from other + applications can be provided using this API. This library is used to interact + with the Cloud Trace API directly. If you are looking to instrument your application + for Cloud Trace, we recommend using OpenCensus. + discoveryRestUrl: https://cloudtrace.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/trace + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudtrace:v1 + kind: discovery#directoryItem + name: cloudtrace + preferred: false + title: Cloud Trace API + version: v1 + cloudtrace:v2beta1: + description: Sends application trace data to Cloud Trace for viewing. Trace data + is collected for all App Engine applications by default. Trace data from other + applications can be provided using this API. This library is used to interact + with the Cloud Trace API directly. If you are looking to instrument your application + for Cloud Trace, we recommend using OpenCensus. + discoveryRestUrl: https://cloudtrace.googleapis.com/services/$discovery-rest?version=v2beta1 + documentationLink: https://cloud.google.com/trace + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: cloudtrace:v2beta1 + kind: discovery#directoryItem + name: cloudtrace + preferred: false + title: Cloud Trace API + version: v2beta1 + composer: + description: Manages Apache Airflow environments on Google Cloud Platform. + discoveryRestUrl: https://composer.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/composer/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: composer:v1 + kind: discovery#directoryItem + name: composer + preferred: true + service: + $ref: googleapis.com/v1/services/composer-v1.yaml + title: Cloud Composer API + version: v1 + composer:v1beta1: + description: Manages Apache Airflow environments on Google Cloud Platform. + discoveryRestUrl: https://composer.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/composer/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: composer:v1beta1 + kind: discovery#directoryItem + name: composer + preferred: false + title: Cloud Composer API + version: v1beta1 + compute: + description: Creates and runs virtual machines on Google Cloud Platform. + discoveryLink: ./apis/compute/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/compute/v1-rest + documentationLink: https://developers.google.com/compute/docs/reference/latest/ + icons: + x16: https://www.google.com/images/icons/product/compute_engine-16.png + x32: https://www.google.com/images/icons/product/compute_engine-32.png + id: compute:v1 + kind: discovery#directoryItem + name: compute + preferred: true + service: + $ref: googleapis.com/v1/services/compute-v1.yaml + resources: + $ref: googleapis.com/v1/resources/compute-v1.yaml + title: Compute Engine API + version: v1 + compute:alpha: + description: Creates and runs virtual machines on Google Cloud Platform. + discoveryLink: ./apis/compute/alpha/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/compute/alpha-rest + documentationLink: https://developers.google.com/compute/docs/reference/latest/ + icons: + x16: https://www.google.com/images/icons/product/compute_engine-16.png + x32: https://www.google.com/images/icons/product/compute_engine-32.png + id: compute:alpha + kind: discovery#directoryItem + name: compute + preferred: false + title: Compute Engine API + version: alpha + compute:beta: + description: Creates and runs virtual machines on Google Cloud Platform. + discoveryLink: ./apis/compute/beta/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/compute/beta-rest + documentationLink: https://developers.google.com/compute/docs/reference/latest/ + icons: + x16: https://www.google.com/images/icons/product/compute_engine-16.png + x32: https://www.google.com/images/icons/product/compute_engine-32.png + id: compute:beta + kind: discovery#directoryItem + name: compute + preferred: false + title: Compute Engine API + version: beta + container: + description: Builds and manages container-based applications, powered by the open + source Kubernetes technology. + discoveryRestUrl: https://container.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/container-engine/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: container:v1 + kind: discovery#directoryItem + name: container + preferred: true + service: + $ref: googleapis.com/v1/services/container-v1.yaml + title: Kubernetes Engine API + version: v1 + container:v1beta1: + description: Builds and manages container-based applications, powered by the open + source Kubernetes technology. + discoveryRestUrl: https://container.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/container-engine/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: container:v1beta1 + kind: discovery#directoryItem + name: container + preferred: false + title: Kubernetes Engine API + version: v1beta1 + containeranalysis: + description: An implementation of the Grafeas API, which stores, and enables querying + and retrieval of critical metadata about all of your software artifacts. + discoveryRestUrl: https://containeranalysis.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://cloud.google.com/container-analysis/api/reference/rest/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: containeranalysis:v1alpha1 + kind: discovery#directoryItem + name: containeranalysis + preferred: true + service: + $ref: googleapis.com/v1/services/containeranalysis-v1alpha1.yaml + title: Container Analysis API + version: v1alpha1 + containeranalysis:v1beta1: + description: An implementation of the Grafeas API, which stores, and enables querying + and retrieval of critical metadata about all of your software artifacts. + discoveryRestUrl: https://containeranalysis.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/container-analysis/api/reference/rest/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: containeranalysis:v1beta1 + kind: discovery#directoryItem + name: containeranalysis + preferred: false + title: Container Analysis API + version: v1beta1 + content: + description: Manages product items, inventory, and Merchant Center accounts for + Google Shopping. + discoveryLink: ./apis/content/v2.1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/content/v2.1-rest + documentationLink: https://developers.google.com/shopping-content + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: content:v2.1 + kind: discovery#directoryItem + name: content + preferred: true + service: + $ref: googleapis.com/v1/services/content-v2.1.yaml + title: Content API for Shopping + version: v2.1 + content:v2: + description: Manages product items, inventory, and Merchant Center accounts for + Google Shopping. + discoveryLink: ./apis/content/v2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/content/v2-rest + documentationLink: https://developers.google.com/shopping-content + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: content:v2 + kind: discovery#directoryItem + name: content + preferred: false + title: Content API for Shopping + version: v2 + customsearch: + description: Searches over a website or collection of websites + discoveryRestUrl: https://customsearch.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/custom-search/v1/introduction + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: customsearch:v1 + kind: discovery#directoryItem + name: customsearch + preferred: true + service: + $ref: googleapis.com/v1/services/customsearch-v1.yaml + title: Custom Search API + version: v1 + datacatalog: + description: A fully managed and highly scalable data discovery and metadata management + service. + discoveryRestUrl: https://datacatalog.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/data-catalog/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: datacatalog:v1beta1 + kind: discovery#directoryItem + name: datacatalog + preferred: true + service: + $ref: googleapis.com/v1/services/datacatalog-v1beta1.yaml + title: Google Cloud Data Catalog API + version: v1beta1 + dataflow: + description: Manages Google Cloud Dataflow projects on Google Cloud Platform. + discoveryRestUrl: https://dataflow.googleapis.com/services/$discovery-rest?version=v1b3 + documentationLink: https://cloud.google.com/dataflow + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dataflow:v1b3 + kind: discovery#directoryItem + name: dataflow + preferred: true + service: + $ref: googleapis.com/v1/services/dataflow-v1b3.yaml + title: Dataflow API + version: v1b3 + datafusion: + description: Cloud Data Fusion is a fully-managed, cloud native, enterprise data + integration service for quickly building and managing data pipelines. It provides + a graphical interface to increase time efficiency and reduce complexity, and + allows business users, developers, and data scientists to easily and reliably + build scalable data integration solutions to cleanse, prepare, blend, transfer + and transform data without having to wrestle with infrastructure. + discoveryRestUrl: https://datafusion.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/data-fusion/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: datafusion:v1 + kind: discovery#directoryItem + name: datafusion + preferred: true + service: + $ref: googleapis.com/v1/services/datafusion-v1.yaml + title: Cloud Data Fusion API + version: v1 + datafusion:v1beta1: + description: Cloud Data Fusion is a fully-managed, cloud native, enterprise data + integration service for quickly building and managing data pipelines. It provides + a graphical interface to increase time efficiency and reduce complexity, and + allows business users, developers, and data scientists to easily and reliably + build scalable data integration solutions to cleanse, prepare, blend, transfer + and transform data without having to wrestle with infrastructure. + discoveryRestUrl: https://datafusion.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/data-fusion/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: datafusion:v1beta1 + kind: discovery#directoryItem + name: datafusion + preferred: false + title: Cloud Data Fusion API + version: v1beta1 + dataproc: + description: Manages Hadoop-based clusters and jobs on Google Cloud Platform. + discoveryRestUrl: https://dataproc.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/dataproc/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dataproc:v1 + kind: discovery#directoryItem + name: dataproc + preferred: true + service: + $ref: googleapis.com/v1/services/dataproc-v1.yaml + title: Cloud Dataproc API + version: v1 + dataproc:v1beta2: + description: Manages Hadoop-based clusters and jobs on Google Cloud Platform. + discoveryRestUrl: https://dataproc.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://cloud.google.com/dataproc/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dataproc:v1beta2 + kind: discovery#directoryItem + name: dataproc + preferred: false + title: Cloud Dataproc API + version: v1beta2 + datastore: + description: Accesses the schemaless NoSQL database to provide fully managed, + robust, scalable storage for your application. + discoveryRestUrl: https://datastore.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/datastore/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: datastore:v1 + kind: discovery#directoryItem + name: datastore + preferred: true + service: + $ref: googleapis.com/v1/services/datastore-v1.yaml + title: Cloud Datastore API + version: v1 + datastore:v1beta1: + description: Accesses the schemaless NoSQL database to provide fully managed, + robust, scalable storage for your application. + discoveryRestUrl: https://datastore.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/datastore/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: datastore:v1beta1 + kind: discovery#directoryItem + name: datastore + preferred: false + title: Cloud Datastore API + version: v1beta1 + datastore:v1beta3: + description: Accesses the schemaless NoSQL database to provide fully managed, + robust, scalable storage for your application. + discoveryRestUrl: https://datastore.googleapis.com/services/$discovery-rest?version=v1beta3 + documentationLink: https://cloud.google.com/datastore/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: datastore:v1beta3 + kind: discovery#directoryItem + name: datastore + preferred: false + title: Cloud Datastore API + version: v1beta3 + deploymentmanager: + description: Declares, configures, and deploys complex solutions on Google Cloud + Platform. + discoveryLink: ./apis/deploymentmanager/v2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/deploymentmanager/v2-rest + documentationLink: https://cloud.google.com/deployment-manager/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: deploymentmanager:v2 + kind: discovery#directoryItem + name: deploymentmanager + preferred: true + service: + $ref: googleapis.com/v1/services/deploymentmanager-v2.yaml + title: Google Cloud Deployment Manager API + version: v2 + deploymentmanager:alpha: + description: The Deployment Manager API allows users to declaratively configure, + deploy and run complex solutions on the Google Cloud Platform. + discoveryLink: ./apis/deploymentmanager/alpha/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/deploymentmanager/alpha-rest + documentationLink: https://cloud.google.com/deployment-manager/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: deploymentmanager:alpha + kind: discovery#directoryItem + name: deploymentmanager + preferred: false + title: Google Cloud Deployment Manager Alpha API + version: alpha + deploymentmanager:v2beta: + description: The Deployment Manager API allows users to declaratively configure, + deploy and run complex solutions on the Google Cloud Platform. + discoveryLink: ./apis/deploymentmanager/v2beta/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/deploymentmanager/v2beta-rest + documentationLink: https://developers.google.com/deployment-manager/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: deploymentmanager:v2beta + kind: discovery#directoryItem + name: deploymentmanager + preferred: false + title: Google Cloud Deployment Manager API V2Beta Methods + version: v2beta + dfareporting: + description: Manages your DoubleClick Campaign Manager ad campaigns and reports. + discoveryLink: ./apis/dfareporting/v3.4/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/dfareporting/v3.4-rest + documentationLink: https://developers.google.com/doubleclick-advertisers/ + icons: + x16: https://www.google.com/images/icons/product/doubleclick-16.gif + x32: https://www.google.com/images/icons/product/doubleclick-32.gif + id: dfareporting:v3.4 + kind: discovery#directoryItem + name: dfareporting + preferred: true + service: + $ref: googleapis.com/v1/services/dfareporting-v3.4.yaml + title: DCM/DFA Reporting And Trafficking API + version: v3.4 + dfareporting:v3.3: + description: Manages your DoubleClick Campaign Manager ad campaigns and reports. + discoveryLink: ./apis/dfareporting/v3.3/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/dfareporting/v3.3-rest + documentationLink: https://developers.google.com/doubleclick-advertisers/ + icons: + x16: https://www.google.com/images/icons/product/doubleclick-16.gif + x32: https://www.google.com/images/icons/product/doubleclick-32.gif + id: dfareporting:v3.3 + kind: discovery#directoryItem + name: dfareporting + preferred: false + title: DCM/DFA Reporting And Trafficking API + version: v3.3 + dialogflow: + description: Builds conversational interfaces (for example, chatbots, and voice-powered + apps and devices). + discoveryRestUrl: https://dialogflow.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/dialogflow/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dialogflow:v2 + kind: discovery#directoryItem + name: dialogflow + preferred: true + service: + $ref: googleapis.com/v1/services/dialogflow-v2.yaml + title: Dialogflow API + version: v2 + dialogflow:v2beta1: + description: Builds conversational interfaces (for example, chatbots, and voice-powered + apps and devices). + discoveryRestUrl: https://dialogflow.googleapis.com/services/$discovery-rest?version=v2beta1 + documentationLink: https://cloud.google.com/dialogflow/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dialogflow:v2beta1 + kind: discovery#directoryItem + name: dialogflow + preferred: false + title: Dialogflow API + version: v2beta1 + digitalassetlinks: + description: Discovers relationships between online assets such as websites or + mobile apps. + discoveryRestUrl: https://digitalassetlinks.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/digital-asset-links/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: digitalassetlinks:v1 + kind: discovery#directoryItem + name: digitalassetlinks + preferred: true + service: + $ref: googleapis.com/v1/services/digitalassetlinks-v1.yaml + title: Digital Asset Links API + version: v1 + discovery: + description: Provides information about other Google APIs, such as what APIs are + available, the resource, and method details for each API. + discoveryLink: ./apis/discovery/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/discovery/v1-rest + documentationLink: https://developers.google.com/discovery/ + icons: + x16: http://www.google.com/images/icons/feature/filing_cabinet_search-g16.png + x32: http://www.google.com/images/icons/feature/filing_cabinet_search-g32.png + id: discovery:v1 + kind: discovery#directoryItem + name: discovery + preferred: true + service: + $ref: googleapis.com/v1/services/discovery-v1.yaml + title: API Discovery Service + version: v1 + displayvideo: + description: Display & Video 360 API allows users to manage and create campaigns + and reports. + discoveryRestUrl: https://displayvideo.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/display-video/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: displayvideo:v1 + kind: discovery#directoryItem + name: displayvideo + preferred: true + service: + $ref: googleapis.com/v1/services/displayvideo-v1.yaml + title: Display & Video 360 API + version: v1 + dlp: + description: Provides methods for detection, risk analysis, and de-identification + of privacy-sensitive fragments in text, images, and Google Cloud Platform storage + repositories. + discoveryRestUrl: https://dlp.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/dlp/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dlp:v2 + kind: discovery#directoryItem + name: dlp + preferred: true + service: + $ref: googleapis.com/v1/services/dlp-v2.yaml + title: Cloud Data Loss Prevention (DLP) API + version: v2 + dns: + description: Configures and serves authoritative DNS records. + discoveryLink: ./apis/dns/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/dns/v1-rest + documentationLink: https://developers.google.com/cloud-dns + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dns:v1 + kind: discovery#directoryItem + name: dns + preferred: true + service: + $ref: googleapis.com/v1/services/dns-v1.yaml + title: Google Cloud DNS API + version: v1 + dns:v1beta2: + description: Configures and serves authoritative DNS records. + discoveryLink: ./apis/dns/v1beta2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/dns/v1beta2-rest + documentationLink: https://developers.google.com/cloud-dns + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dns:v1beta2 + kind: discovery#directoryItem + name: dns + preferred: false + title: Google Cloud DNS API + version: v1beta2 + dns:v2beta1: + description: Configures and serves authoritative DNS records. + discoveryLink: ./apis/dns/v2beta1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/dns/v2beta1-rest + documentationLink: https://developers.google.com/cloud-dns + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: dns:v2beta1 + kind: discovery#directoryItem + name: dns + preferred: false + title: Google Cloud DNS API + version: v2beta1 + docs: + description: Reads and writes Google Docs documents. + discoveryRestUrl: https://docs.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: docs:v1 + kind: discovery#directoryItem + name: docs + preferred: true + service: + $ref: googleapis.com/v1/services/docs-v1.yaml + title: Google Docs API + version: v1 + documentai: + description: Service to parse structured information from unstructured or semi-structured + documents using state-of-the-art Google AI such as natural language, computer + vision, translation, and AutoML. + discoveryRestUrl: https://documentai.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://cloud.google.com/document-ai/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: documentai:v1beta2 + kind: discovery#directoryItem + name: documentai + preferred: true + service: + $ref: googleapis.com/v1/services/documentai-v1beta2.yaml + title: Cloud Document AI API + version: v1beta2 + domainsrdap: + description: Read-only public API that lets users search for information about + domain names. + discoveryRestUrl: https://domainsrdap.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/domains/rdap/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: domainsrdap:v1 + kind: discovery#directoryItem + name: domainsrdap + preferred: true + service: + $ref: googleapis.com/v1/services/domainsrdap-v1.yaml + title: Domains RDAP API + version: v1 + doubleclickbidmanager: + description: API for viewing and managing your reports in DoubleClick Bid Manager. + discoveryLink: ./apis/doubleclickbidmanager/v1.1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/doubleclickbidmanager/v1.1-rest + documentationLink: https://developers.google.com/bid-manager/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: doubleclickbidmanager:v1.1 + kind: discovery#directoryItem + labels: + - limited_availability + name: doubleclickbidmanager + preferred: true + service: + $ref: googleapis.com/v1/services/doubleclickbidmanager-v1.1.yaml + title: DoubleClick Bid Manager API + version: v1.1 + doubleclickbidmanager:v1: + description: API for viewing and managing your reports in DoubleClick Bid Manager. + discoveryLink: ./apis/doubleclickbidmanager/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/doubleclickbidmanager/v1-rest + documentationLink: https://developers.google.com/bid-manager/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: doubleclickbidmanager:v1 + kind: discovery#directoryItem + labels: + - limited_availability + name: doubleclickbidmanager + preferred: false + title: DoubleClick Bid Manager API + version: v1 + doubleclicksearch: + description: Reports and modifies your advertising data in DoubleClick Search + (for example, campaigns, ad groups, keywords, and conversions). + discoveryLink: ./apis/doubleclicksearch/v2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/doubleclicksearch/v2-rest + documentationLink: https://developers.google.com/doubleclick-search/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: doubleclicksearch:v2 + kind: discovery#directoryItem + name: doubleclicksearch + preferred: true + service: + $ref: googleapis.com/v1/services/doubleclicksearch-v2.yaml + title: Search Ads 360 API + version: v2 + drive: + description: Manages files in Drive including uploading, downloading, searching, + detecting changes, and updating sharing permissions. + discoveryLink: ./apis/drive/v3/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/drive/v3-rest + documentationLink: https://developers.google.com/drive/ + icons: + x16: https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png + x32: https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png + id: drive:v3 + kind: discovery#directoryItem + name: drive + preferred: true + service: + $ref: googleapis.com/v1/services/drive-v3.yaml + title: Drive API + version: v3 + drive:v2: + description: Manages files in Drive including uploading, downloading, searching, + detecting changes, and updating sharing permissions. + discoveryLink: ./apis/drive/v2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/drive/v2-rest + documentationLink: https://developers.google.com/drive/ + icons: + x16: https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png + x32: https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png + id: drive:v2 + kind: discovery#directoryItem + name: drive + preferred: false + title: Drive API + version: v2 + driveactivity: + description: Provides a historical view of activity in Google Drive. + discoveryRestUrl: https://driveactivity.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://developers.google.com/drive/activity/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: driveactivity:v2 + kind: discovery#directoryItem + name: driveactivity + preferred: true + service: + $ref: googleapis.com/v1/services/driveactivity-v2.yaml + title: Drive Activity API + version: v2 + factchecktools: + description: '' + discoveryRestUrl: https://factchecktools.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://developers.google.com/fact-check/tools/api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: factchecktools:v1alpha1 + kind: discovery#directoryItem + name: factchecktools + preferred: true + service: + $ref: googleapis.com/v1/services/factchecktools-v1alpha1.yaml + title: Fact Check Tools API + version: v1alpha1 + fcm: + description: FCM send API that provides a cross-platform messaging solution to + reliably deliver messages at no cost. + discoveryRestUrl: https://fcm.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://firebase.google.com/docs/cloud-messaging + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: fcm:v1 + kind: discovery#directoryItem + name: fcm + preferred: true + service: + $ref: googleapis.com/v1/services/fcm-v1.yaml + title: Firebase Cloud Messaging API + version: v1 + file: + description: The Cloud Filestore API is used for creating and managing cloud file + servers. + discoveryRestUrl: https://file.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/filestore/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: file:v1 + kind: discovery#directoryItem + name: file + preferred: true + service: + $ref: googleapis.com/v1/services/file-v1.yaml + title: Cloud Filestore API + version: v1 + file:v1beta1: + description: The Cloud Filestore API is used for creating and managing cloud file + servers. + discoveryRestUrl: https://file.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/filestore/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: file:v1beta1 + kind: discovery#directoryItem + name: file + preferred: false + title: Cloud Filestore API + version: v1beta1 + firebase: + description: The Firebase Management API enables programmatic setup and management + of Firebase projects, including a project's Firebase resources and Firebase + apps. + discoveryRestUrl: https://firebase.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://firebase.google.com + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firebase:v1beta1 + kind: discovery#directoryItem + name: firebase + preferred: true + service: + $ref: googleapis.com/v1/services/firebase-v1beta1.yaml + title: Firebase Management API + version: v1beta1 + firebasedynamiclinks: + description: Programmatically creates and manages Firebase Dynamic Links. + discoveryRestUrl: https://firebasedynamiclinks.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://firebase.google.com/docs/dynamic-links/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firebasedynamiclinks:v1 + kind: discovery#directoryItem + name: firebasedynamiclinks + preferred: true + service: + $ref: googleapis.com/v1/services/firebasedynamiclinks-v1.yaml + title: Firebase Dynamic Links API + version: v1 + firebasehosting: + description: The Firebase Hosting REST API enables programmatic and customizable + deployments to your Firebase-hosted sites. Use this REST API to deploy new or + updated hosting configurations and content files. + discoveryRestUrl: https://firebasehosting.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://firebase.google.com/docs/hosting/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firebasehosting:v1 + kind: discovery#directoryItem + name: firebasehosting + preferred: true + service: + $ref: googleapis.com/v1/services/firebasehosting-v1.yaml + title: Firebase Hosting API + version: v1 + firebasehosting:v1beta1: + description: The Firebase Hosting REST API enables programmatic and customizable + deployments to your Firebase-hosted sites. Use this REST API to deploy new or + updated hosting configurations and content files. + discoveryRestUrl: https://firebasehosting.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://firebase.google.com/docs/hosting/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firebasehosting:v1beta1 + kind: discovery#directoryItem + name: firebasehosting + preferred: false + title: Firebase Hosting API + version: v1beta1 + firebaseml: + description: Access custom machine learning models hosted via Firebase ML. + discoveryRestUrl: https://firebaseml.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://firebase.google.com + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firebaseml:v1 + kind: discovery#directoryItem + name: firebaseml + preferred: true + service: + $ref: googleapis.com/v1/services/firebaseml-v1.yaml + title: Firebase ML API + version: v1 + firebaseml:v1beta2: + description: Access custom machine learning models hosted via Firebase ML. + discoveryRestUrl: https://firebaseml.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://firebase.google.com + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firebaseml:v1beta2 + kind: discovery#directoryItem + name: firebaseml + preferred: false + title: Firebase ML API + version: v1beta2 + firebaserules: + description: Creates and manages rules that determine when a Firebase Rules-enabled + service should permit a request. + discoveryRestUrl: https://firebaserules.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://firebase.google.com/docs/storage/security + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firebaserules:v1 + kind: discovery#directoryItem + name: firebaserules + preferred: true + service: + $ref: googleapis.com/v1/services/firebaserules-v1.yaml + title: Firebase Rules API + version: v1 + firestore: + description: Accesses the NoSQL document database built for automatic scaling, + high performance, and ease of application development. + discoveryRestUrl: https://firestore.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/firestore + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firestore:v1 + kind: discovery#directoryItem + name: firestore + preferred: true + service: + $ref: googleapis.com/v1/services/firestore-v1.yaml + title: Cloud Firestore API + version: v1 + firestore:v1beta1: + description: Accesses the NoSQL document database built for automatic scaling, + high performance, and ease of application development. + discoveryRestUrl: https://firestore.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/firestore + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firestore:v1beta1 + kind: discovery#directoryItem + name: firestore + preferred: false + title: Cloud Firestore API + version: v1beta1 + firestore:v1beta2: + description: Accesses the NoSQL document database built for automatic scaling, + high performance, and ease of application development. + discoveryRestUrl: https://firestore.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://cloud.google.com/firestore + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: firestore:v1beta2 + kind: discovery#directoryItem + name: firestore + preferred: false + title: Cloud Firestore API + version: v1beta2 + games: + description: The Google Play games service allows developers to enhance games + with social leaderboards, achievements, game state, sign-in with Google, and + more. + discoveryRestUrl: https://games.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/games/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: games:v1 + kind: discovery#directoryItem + name: games + preferred: true + service: + $ref: googleapis.com/v1/services/games-v1.yaml + title: Google Play Game Services + version: v1 + gamesConfiguration: + description: The Google Play Game Services Publishing API allows developers to + configure their games in Game Services. + discoveryRestUrl: https://gamesconfiguration.googleapis.com/services/$discovery-rest?version=v1configuration + documentationLink: https://developers.google.com/games/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: gamesConfiguration:v1configuration + kind: discovery#directoryItem + name: gamesConfiguration + preferred: true + service: + $ref: googleapis.com/v1/services/gamesConfiguration-v1configuration.yaml + title: Google Play Game Services Publishing API + version: v1configuration + gamesManagement: + description: The Google Play Game Management API allows developers to manage resources + from the Google Play Game service. + discoveryRestUrl: https://gamesmanagement.googleapis.com/services/$discovery-rest?version=v1management + documentationLink: https://developers.google.com/games/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: gamesManagement:v1management + kind: discovery#directoryItem + name: gamesManagement + preferred: true + service: + $ref: googleapis.com/v1/services/gamesManagement-v1management.yaml + title: Google Play Game Management + version: v1management + gameservices: + description: Deploy and manage infrastructure for global multiplayer gaming experiences. + discoveryRestUrl: https://gameservices.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/solutions/gaming/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: gameservices:v1 + kind: discovery#directoryItem + name: gameservices + preferred: true + service: + $ref: googleapis.com/v1/services/gameservices-v1.yaml + title: Game Services API + version: v1 + gameservices:v1beta: + description: Deploy and manage infrastructure for global multiplayer gaming experiences. + discoveryRestUrl: https://gameservices.googleapis.com/services/$discovery-rest?version=v1beta + documentationLink: https://cloud.google.com/solutions/gaming/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: gameservices:v1beta + kind: discovery#directoryItem + name: gameservices + preferred: false + title: Game Services API + version: v1beta + genomics: + description: Uploads, processes, queries, and searches Genomics data in the cloud. + discoveryRestUrl: https://genomics.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/genomics + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: genomics:v1 + kind: discovery#directoryItem + name: genomics + preferred: true + service: + $ref: googleapis.com/v1/services/genomics-v1.yaml + title: Genomics API + version: v1 + genomics:v1alpha2: + description: Uploads, processes, queries, and searches Genomics data in the cloud. + discoveryRestUrl: https://genomics.googleapis.com/services/$discovery-rest?version=v1alpha2 + documentationLink: https://cloud.google.com/genomics + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: genomics:v1alpha2 + kind: discovery#directoryItem + name: genomics + preferred: false + title: Genomics API + version: v1alpha2 + genomics:v2alpha1: + description: Uploads, processes, queries, and searches Genomics data in the cloud. + discoveryRestUrl: https://genomics.googleapis.com/services/$discovery-rest?version=v2alpha1 + documentationLink: https://cloud.google.com/genomics + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: genomics:v2alpha1 + kind: discovery#directoryItem + name: genomics + preferred: false + title: Genomics API + version: v2alpha1 + gmail: + description: Access Gmail mailboxes including sending user email. + discoveryLink: ./apis/gmail/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/gmail/v1-rest + documentationLink: https://developers.google.com/gmail/api/ + icons: + x16: https://www.google.com/images/icons/product/googlemail-16.png + x32: https://www.google.com/images/icons/product/googlemail-32.png + id: gmail:v1 + kind: discovery#directoryItem + name: gmail + preferred: true + service: + $ref: googleapis.com/v1/services/gmail-v1.yaml + title: Gmail API + version: v1 + gmailpostmastertools: + description: The Gmail Postmaster API is a RESTful API that provides programmatic + access to email traffic metrics (like spam reports, delivery errors etc) otherwise + available through the Gmail Postmaster Tools UI currently. + discoveryRestUrl: https://gmailpostmastertools.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://developers.google.com/gmail/postmaster + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: gmailpostmastertools:v1beta1 + kind: discovery#directoryItem + name: gmailpostmastertools + preferred: true + service: + $ref: googleapis.com/v1/services/gmailpostmastertools-v1beta1.yaml + title: Gmail Postmaster Tools API + version: v1beta1 + groupssettings: + description: Manages permission levels and related settings of a group. + discoveryLink: ./apis/groupssettings/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/groupssettings/v1-rest + documentationLink: https://developers.google.com/google-apps/groups-settings/get_started + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: groupssettings:v1 + kind: discovery#directoryItem + name: groupssettings + preferred: true + service: + $ref: googleapis.com/v1/services/groupssettings-v1.yaml + title: Groups Settings API + version: v1 + healthcare: + description: Manage, store, and access healthcare data in Google Cloud Platform. + discoveryRestUrl: https://healthcare.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/healthcare + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: healthcare:v1 + kind: discovery#directoryItem + name: healthcare + preferred: true + service: + $ref: googleapis.com/v1/services/healthcare-v1.yaml + title: Cloud Healthcare API + version: v1 + healthcare:v1beta1: + description: Manage, store, and access healthcare data in Google Cloud Platform. + discoveryRestUrl: https://healthcare.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/healthcare + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: healthcare:v1beta1 + kind: discovery#directoryItem + name: healthcare + preferred: false + title: Cloud Healthcare API + version: v1beta1 + homegraph: + description: '' + discoveryRestUrl: https://homegraph.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/actions/smarthome/create-app#request-sync + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: homegraph:v1 + kind: discovery#directoryItem + name: homegraph + preferred: true + service: + $ref: googleapis.com/v1/services/homegraph-v1.yaml + title: HomeGraph API + version: v1 + iam: + description: Manages identity and access control for Google Cloud Platform resources, + including the creation of service accounts, which you can use to authenticate + to Google and make API calls. + discoveryRestUrl: https://iam.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/iam/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: iam:v1 + kind: discovery#directoryItem + name: iam + preferred: true + service: + $ref: googleapis.com/v1/services/iam-v1.yaml + title: Identity and Access Management (IAM) API + version: v1 + iamcredentials: + description: Creates short-lived credentials for impersonating IAM service accounts. + discoveryRestUrl: https://iamcredentials.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: iamcredentials:v1 + kind: discovery#directoryItem + name: iamcredentials + preferred: true + service: + $ref: googleapis.com/v1/services/iamcredentials-v1.yaml + title: IAM Service Account Credentials API + version: v1 + iap: + description: Controls access to cloud applications running on Google Cloud Platform. + discoveryRestUrl: https://iap.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/iap + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: iap:v1 + kind: discovery#directoryItem + name: iap + preferred: true + service: + $ref: googleapis.com/v1/services/iap-v1.yaml + title: Cloud Identity-Aware Proxy API + version: v1 + iap:v1beta1: + description: Controls access to cloud applications running on Google Cloud Platform. + discoveryRestUrl: https://iap.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/iap + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: iap:v1beta1 + kind: discovery#directoryItem + name: iap + preferred: false + title: Cloud Identity-Aware Proxy API + version: v1beta1 + identitytoolkit: + description: The Google Identity Toolkit API lets you use open standards to verify + a user's identity. + discoveryRestUrl: https://identitytoolkit.googleapis.com/services/$discovery-rest?version=v3 + documentationLink: https://firebase.google.com/docs/auth/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: identitytoolkit:v3 + kind: discovery#directoryItem + name: identitytoolkit + preferred: true + service: + $ref: googleapis.com/v1/services/identitytoolkit-v3.yaml + title: Identity Toolkit API + version: v3 + indexing: + description: Notifies Google when your web pages change. + discoveryRestUrl: https://indexing.googleapis.com/services/$discovery-rest?version=v3 + documentationLink: https://developers.google.com/search/apis/indexing-api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: indexing:v3 + kind: discovery#directoryItem + name: indexing + preferred: true + service: + $ref: googleapis.com/v1/services/indexing-v3.yaml + title: Indexing API + version: v3 + jobs: + description: Cloud Talent Solution provides the capability to create, read, update, + and delete job postings, as well as search jobs based on keywords and filters. + discoveryRestUrl: https://jobs.googleapis.com/services/$discovery-rest?version=v3 + documentationLink: https://cloud.google.com/talent-solution/job-search/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: jobs:v3 + kind: discovery#directoryItem + name: jobs + preferred: true + service: + $ref: googleapis.com/v1/services/jobs-v3.yaml + title: Cloud Talent Solution API + version: v3 + jobs:v2: + description: Cloud Talent Solution provides the capability to create, read, update, + and delete job postings, as well as search jobs based on keywords and filters. + discoveryRestUrl: https://jobs.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/talent-solution/job-search/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: jobs:v2 + kind: discovery#directoryItem + name: jobs + preferred: false + title: Cloud Talent Solution API + version: v2 + jobs:v3p1beta1: + description: Cloud Talent Solution provides the capability to create, read, update, + and delete job postings, as well as search jobs based on keywords and filters. + discoveryRestUrl: https://jobs.googleapis.com/services/$discovery-rest?version=v3p1beta1 + documentationLink: https://cloud.google.com/talent-solution/job-search/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: jobs:v3p1beta1 + kind: discovery#directoryItem + name: jobs + preferred: false + title: Cloud Talent Solution API + version: v3p1beta1 + kgsearch: + description: Searches the Google Knowledge Graph for entities. + discoveryRestUrl: https://kgsearch.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/knowledge-graph/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: kgsearch:v1 + kind: discovery#directoryItem + name: kgsearch + preferred: true + service: + $ref: googleapis.com/v1/services/kgsearch-v1.yaml + title: Knowledge Graph Search API + version: v1 + language: + description: Provides natural language understanding technologies, such as sentiment + analysis, entity recognition, entity sentiment analysis, and other text annotations, + to developers. + discoveryRestUrl: https://language.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/natural-language/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: language:v1 + kind: discovery#directoryItem + name: language + preferred: true + service: + $ref: googleapis.com/v1/services/language-v1.yaml + title: Cloud Natural Language API + version: v1 + language:v1beta1: + description: Provides natural language understanding technologies, such as sentiment + analysis, entity recognition, entity sentiment analysis, and other text annotations, + to developers. + discoveryRestUrl: https://language.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/natural-language/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: language:v1beta1 + kind: discovery#directoryItem + name: language + preferred: false + title: Cloud Natural Language API + version: v1beta1 + language:v1beta2: + description: Provides natural language understanding technologies, such as sentiment + analysis, entity recognition, entity sentiment analysis, and other text annotations, + to developers. + discoveryRestUrl: https://language.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://cloud.google.com/natural-language/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: language:v1beta2 + kind: discovery#directoryItem + name: language + preferred: false + title: Cloud Natural Language API + version: v1beta2 + libraryagent: + description: A simple Google Example Library API. + discoveryRestUrl: https://libraryagent.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/docs/quota + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: libraryagent:v1 + kind: discovery#directoryItem + name: libraryagent + preferred: true + service: + $ref: googleapis.com/v1/services/libraryagent-v1.yaml + title: Library Agent API + version: v1 + licensing: + description: Licensing API to view and manage licenses for your domain + discoveryLink: ./apis/licensing/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/licensing/v1-rest + documentationLink: https://developers.google.com/admin-sdk/licensing/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: licensing:v1 + kind: discovery#directoryItem + name: licensing + preferred: true + service: + $ref: googleapis.com/v1/services/licensing-v1.yaml + title: Licensing API + version: v1 + lifesciences: + description: Cloud Life Sciences is a suite of services and tools for managing, + processing, and transforming life sciences data. + discoveryRestUrl: https://lifesciences.googleapis.com/services/$discovery-rest?version=v2beta + documentationLink: https://cloud.google.com/life-sciences + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: lifesciences:v2beta + kind: discovery#directoryItem + name: lifesciences + preferred: true + service: + $ref: googleapis.com/v1/services/lifesciences-v2beta.yaml + title: Cloud Life Sciences API + version: v2beta + logging: + description: Writes log entries and manages your Cloud Logging configuration. + The table entries below are presented in alphabetical order, not in order of + common use. For explanations of the concepts found in the table entries, read + the documentation at https://cloud.google.com/logging/docs. + discoveryRestUrl: https://logging.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/logging/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: logging:v2 + kind: discovery#directoryItem + name: logging + preferred: true + service: + $ref: googleapis.com/v1/services/logging-v2.yaml + title: Cloud Logging API + version: v2 + managedidentities: + description: The Managed Service for Microsoft Active Directory API is used for + managing a highly available, hardened service running Microsoft Active Directory + (AD). + discoveryRestUrl: https://managedidentities.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/managed-microsoft-ad/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: managedidentities:v1 + kind: discovery#directoryItem + name: managedidentities + preferred: true + service: + $ref: googleapis.com/v1/services/managedidentities-v1.yaml + title: Managed Service for Microsoft Active Directory API + version: v1 + managedidentities:v1alpha1: + description: The Managed Service for Microsoft Active Directory API is used for + managing a highly available, hardened service running Microsoft Active Directory + (AD). + discoveryRestUrl: https://managedidentities.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://cloud.google.com/managed-microsoft-ad/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: managedidentities:v1alpha1 + kind: discovery#directoryItem + name: managedidentities + preferred: false + title: Managed Service for Microsoft Active Directory API + version: v1alpha1 + managedidentities:v1beta1: + description: The Managed Service for Microsoft Active Directory API is used for + managing a highly available, hardened service running Microsoft Active Directory + (AD). + discoveryRestUrl: https://managedidentities.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/managed-microsoft-ad/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: managedidentities:v1beta1 + kind: discovery#directoryItem + name: managedidentities + preferred: false + title: Managed Service for Microsoft Active Directory API + version: v1beta1 + manufacturers: + description: Public API for managing Manufacturer Center related data. + discoveryRestUrl: https://manufacturers.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/manufacturers/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: manufacturers:v1 + kind: discovery#directoryItem + name: manufacturers + preferred: true + service: + $ref: googleapis.com/v1/services/manufacturers-v1.yaml + title: Manufacturer Center API + version: v1 + memcache: + description: Google Cloud Memorystore for Memcached API is used for creating and + managing Memcached instances in GCP. + discoveryRestUrl: https://memcache.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/memorystore/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: memcache:v1 + kind: discovery#directoryItem + name: memcache + preferred: true + service: + $ref: googleapis.com/v1/services/memcache-v1.yaml + title: Cloud Memorystore for Memcached API + version: v1 + memcache:v1beta2: + description: Google Cloud Memorystore for Memcached API is used for creating and + managing Memcached instances in GCP. + discoveryRestUrl: https://memcache.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://cloud.google.com/memorystore/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: memcache:v1beta2 + kind: discovery#directoryItem + name: memcache + preferred: false + title: Cloud Memorystore for Memcached API + version: v1beta2 + ml: + description: An API to enable creating and using machine learning models. + discoveryRestUrl: https://ml.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/ml/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: ml:v1 + kind: discovery#directoryItem + name: ml + preferred: true + service: + $ref: googleapis.com/v1/services/ml-v1.yaml + title: AI Platform Training & Prediction API + version: v1 + monitoring: + description: Manages your Cloud Monitoring data and configurations. Most projects + must be associated with a Workspace, with a few exceptions as noted on the individual + method pages. The table entries below are presented in alphabetical order, not + in order of common use. For explanations of the concepts found in the table + entries, read the [Cloud Monitoring documentation](/monitoring/docs). + discoveryRestUrl: https://monitoring.googleapis.com/services/$discovery-rest?version=v3 + documentationLink: https://cloud.google.com/monitoring/api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: monitoring:v3 + kind: discovery#directoryItem + name: monitoring + preferred: true + service: + $ref: googleapis.com/v1/services/monitoring-v3.yaml + title: Cloud Monitoring API + version: v3 + monitoring:v1: + description: Manages your Cloud Monitoring data and configurations. Most projects + must be associated with a Workspace, with a few exceptions as noted on the individual + method pages. The table entries below are presented in alphabetical order, not + in order of common use. For explanations of the concepts found in the table + entries, read the [Cloud Monitoring documentation](/monitoring/docs). + discoveryRestUrl: https://monitoring.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/monitoring/api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: monitoring:v1 + kind: discovery#directoryItem + name: monitoring + preferred: false + title: Cloud Monitoring API + version: v1 + monitoring:v3p1alpha1: + description: Manages your Cloud Monitoring data and configurations. Most projects + must be associated with a Workspace, with a few exceptions as noted on the individual + method pages. The table entries below are presented in alphabetical order, not + in order of common use. For explanations of the concepts found in the table + entries, read the [Cloud Monitoring documentation](/monitoring/docs). + discoveryRestUrl: https://monitoring.googleapis.com/services/$discovery-rest?version=v3p1alpha1 + documentationLink: https://cloud.google.com/monitoring/api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: monitoring:v3p1alpha1 + kind: discovery#directoryItem + name: monitoring + preferred: false + title: Cloud Monitoring API + version: v3p1alpha1 + networkmanagement: + description: The Network Management API provides a collection of network performance + monitoring and diagnostic capabilities. + discoveryRestUrl: https://networkmanagement.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: networkmanagement:v1 + kind: discovery#directoryItem + name: networkmanagement + preferred: true + service: + $ref: googleapis.com/v1/services/networkmanagement-v1.yaml + title: Network Management API + version: v1 + networkmanagement:v1beta1: + description: The Network Management API provides a collection of network performance + monitoring and diagnostic capabilities. + discoveryRestUrl: https://networkmanagement.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: networkmanagement:v1beta1 + kind: discovery#directoryItem + name: networkmanagement + preferred: false + title: Network Management API + version: v1beta1 + oauth2: + description: Obtains end-user authorization grants for use with other Google APIs. + discoveryLink: ./apis/oauth2/v2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/oauth2/v2-rest + documentationLink: https://developers.google.com/identity/protocols/oauth2/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: oauth2:v2 + kind: discovery#directoryItem + name: oauth2 + preferred: true + service: + $ref: googleapis.com/v1/services/oauth2-v2.yaml + title: Google OAuth2 API + version: v2 + osconfig: + description: OS management tools that can be used for patch management, patch + compliance, and configuration management on VM instances. + discoveryRestUrl: https://osconfig.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: osconfig:v1 + kind: discovery#directoryItem + name: osconfig + preferred: true + service: + $ref: googleapis.com/v1/services/osconfig-v1.yaml + title: Cloud OS Config API + version: v1 + osconfig:v1alpha2: + description: OS management tools that can be used for patch management, patch + compliance, and configuration management on VM instances. + discoveryRestUrl: https://osconfig.googleapis.com/services/$discovery-rest?version=v1alpha2 + documentationLink: https://cloud.google.com/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: osconfig:v1alpha2 + kind: discovery#directoryItem + name: osconfig + preferred: false + title: Cloud OS Config API + version: v1alpha2 + osconfig:v1beta: + description: OS management tools that can be used for patch management, patch + compliance, and configuration management on VM instances. + discoveryRestUrl: https://osconfig.googleapis.com/services/$discovery-rest?version=v1beta + documentationLink: https://cloud.google.com/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: osconfig:v1beta + kind: discovery#directoryItem + name: osconfig + preferred: false + title: Cloud OS Config API + version: v1beta + oslogin: + description: You can use OS Login to manage access to your VM instances using + IAM roles. + discoveryRestUrl: https://oslogin.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/compute/docs/oslogin/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: oslogin:v1 + kind: discovery#directoryItem + name: oslogin + preferred: true + service: + $ref: googleapis.com/v1/services/oslogin-v1.yaml + title: Cloud OS Login API + version: v1 + oslogin:v1alpha: + description: You can use OS Login to manage access to your VM instances using + IAM roles. + discoveryRestUrl: https://oslogin.googleapis.com/services/$discovery-rest?version=v1alpha + documentationLink: https://cloud.google.com/compute/docs/oslogin/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: oslogin:v1alpha + kind: discovery#directoryItem + name: oslogin + preferred: false + title: Cloud OS Login API + version: v1alpha + oslogin:v1beta: + description: You can use OS Login to manage access to your VM instances using + IAM roles. + discoveryRestUrl: https://oslogin.googleapis.com/services/$discovery-rest?version=v1beta + documentationLink: https://cloud.google.com/compute/docs/oslogin/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: oslogin:v1beta + kind: discovery#directoryItem + name: oslogin + preferred: false + title: Cloud OS Login API + version: v1beta + pagespeedonline: + description: The PageSpeed Insights API lets you analyze the performance of your + website with a simple API. It offers tailored suggestions for how you can optimize + your site, and lets you easily integrate PageSpeed Insights analysis into your + development tools and workflow. + discoveryRestUrl: https://pagespeedonline.googleapis.com/services/$discovery-rest?version=v5 + documentationLink: https://developers.google.com/speed/docs/insights/v5/about + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: pagespeedonline:v5 + kind: discovery#directoryItem + name: pagespeedonline + preferred: true + service: + $ref: googleapis.com/v1/services/pagespeedonline-v5.yaml + title: PageSpeed Insights API + version: v5 + people: + description: Provides access to information about profiles and contacts. + discoveryRestUrl: https://people.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/people/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: people:v1 + kind: discovery#directoryItem + name: people + preferred: true + service: + $ref: googleapis.com/v1/services/people-v1.yaml + title: People API + version: v1 + playablelocations: + description: '' + discoveryRestUrl: https://playablelocations.googleapis.com/services/$discovery-rest?version=v3 + documentationLink: https://developers.google.com/maps/contact-sales/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: playablelocations:v3 + kind: discovery#directoryItem + name: playablelocations + preferred: true + service: + $ref: googleapis.com/v1/services/playablelocations-v3.yaml + title: Playable Locations API + version: v3 + playcustomapp: + description: An API to publish custom Android apps. + discoveryLink: ./apis/playcustomapp/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/playcustomapp/v1-rest + documentationLink: https://developers.google.com/android/work/play/custom-app-api + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: playcustomapp:v1 + kind: discovery#directoryItem + name: playcustomapp + preferred: true + service: + $ref: googleapis.com/v1/services/playcustomapp-v1.yaml + title: Google Play Custom App Publishing API + version: v1 + plus: + description: Builds on top of the Google+ platform. + discoveryLink: ./apis/plus/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/plus/v1-rest + documentationLink: https://developers.google.com/+/api/ + icons: + x16: http://www.google.com/images/icons/product/gplus-16.png + x32: http://www.google.com/images/icons/product/gplus-32.png + id: plus:v1 + kind: discovery#directoryItem + name: plus + preferred: true + service: + $ref: googleapis.com/v1/services/plus-v1.yaml + title: Google+ API + version: v1 + policytroubleshooter: + description: '' + discoveryRestUrl: https://policytroubleshooter.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/iam/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: policytroubleshooter:v1 + kind: discovery#directoryItem + name: policytroubleshooter + preferred: true + service: + $ref: googleapis.com/v1/services/policytroubleshooter-v1.yaml + title: Policy Troubleshooter API + version: v1 + policytroubleshooter:v1beta: + description: '' + discoveryRestUrl: https://policytroubleshooter.googleapis.com/services/$discovery-rest?version=v1beta + documentationLink: https://cloud.google.com/iam/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: policytroubleshooter:v1beta + kind: discovery#directoryItem + name: policytroubleshooter + preferred: false + title: Policy Troubleshooter API + version: v1beta + poly: + description: The Poly API provides read access to assets hosted on poly.google.com + to all, and upload access to poly.google.com for whitelisted accounts. + discoveryRestUrl: https://poly.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/poly/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: poly:v1 + kind: discovery#directoryItem + name: poly + preferred: true + service: + $ref: googleapis.com/v1/services/poly-v1.yaml + title: Poly API + version: v1 + prod_tt_sasportal: + description: '' + discoveryRestUrl: https://prod-tt-sasportal.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://developers.google.com/spectrum-access-system/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: prod_tt_sasportal:v1alpha1 + kind: discovery#directoryItem + name: prod_tt_sasportal + preferred: true + service: + $ref: googleapis.com/v1/services/prod_tt_sasportal-v1alpha1.yaml + title: SAS Portal API (Testing) + version: v1alpha1 + pubsub: + description: Provides reliable, many-to-many, asynchronous messaging between applications. + discoveryRestUrl: https://pubsub.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/pubsub/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: pubsub:v1 + kind: discovery#directoryItem + name: pubsub + preferred: true + service: + $ref: googleapis.com/v1/services/pubsub-v1.yaml + title: Cloud Pub/Sub API + version: v1 + pubsub:v1beta1a: + description: Provides reliable, many-to-many, asynchronous messaging between applications. + discoveryRestUrl: https://pubsub.googleapis.com/services/$discovery-rest?version=v1beta1a + documentationLink: https://cloud.google.com/pubsub/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: pubsub:v1beta1a + kind: discovery#directoryItem + name: pubsub + preferred: false + title: Cloud Pub/Sub API + version: v1beta1a + pubsub:v1beta2: + description: Provides reliable, many-to-many, asynchronous messaging between applications. + discoveryRestUrl: https://pubsub.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://cloud.google.com/pubsub/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: pubsub:v1beta2 + kind: discovery#directoryItem + name: pubsub + preferred: false + title: Cloud Pub/Sub API + version: v1beta2 + pubsublite: + description: '' + discoveryRestUrl: https://pubsublite.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/pubsub/lite/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: pubsublite:v1 + kind: discovery#directoryItem + name: pubsublite + preferred: true + service: + $ref: googleapis.com/v1/services/pubsublite-v1.yaml + title: Pub/Sub Lite API + version: v1 + realtimebidding: + description: Allows external bidders to manage their RTB integration with Google. + This includes managing bidder endpoints, QPS quotas, configuring what ad inventory + to receive via pretargeting, submitting creatives for verification, and accessing + creative metadata such as approval status. + discoveryRestUrl: https://realtimebidding.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: realtimebidding:v1 + kind: discovery#directoryItem + name: realtimebidding + preferred: true + service: + $ref: googleapis.com/v1/services/realtimebidding-v1.yaml + title: Real-time Bidding API + version: v1 + recommendationengine: + description: Recommendations AI service enables customers to build end-to-end + personalized recommendation systems without requiring a high level of expertise + in machine learning, recommendation system, or Google Cloud. + discoveryRestUrl: https://recommendationengine.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/recommendations-ai/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: recommendationengine:v1beta1 + kind: discovery#directoryItem + name: recommendationengine + preferred: true + service: + $ref: googleapis.com/v1/services/recommendationengine-v1beta1.yaml + title: Recommendations AI + version: v1beta1 + recommender: + description: '' + discoveryRestUrl: https://recommender.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/recommender/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: recommender:v1 + kind: discovery#directoryItem + name: recommender + preferred: true + service: + $ref: googleapis.com/v1/services/recommender-v1.yaml + title: Recommender API + version: v1 + recommender:v1beta1: + description: '' + discoveryRestUrl: https://recommender.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/recommender/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: recommender:v1beta1 + kind: discovery#directoryItem + name: recommender + preferred: false + title: Recommender API + version: v1beta1 + redis: + description: Creates and manages Redis instances on the Google Cloud Platform. + discoveryRestUrl: https://redis.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/memorystore/docs/redis/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: redis:v1 + kind: discovery#directoryItem + name: redis + preferred: true + service: + $ref: googleapis.com/v1/services/redis-v1.yaml + title: Google Cloud Memorystore for Redis API + version: v1 + redis:v1beta1: + description: Creates and manages Redis instances on the Google Cloud Platform. + discoveryRestUrl: https://redis.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/memorystore/docs/redis/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: redis:v1beta1 + kind: discovery#directoryItem + name: redis + preferred: false + title: Google Cloud Memorystore for Redis API + version: v1beta1 + remotebuildexecution: + description: Supplies a Remote Execution API service for tools such as bazel. + discoveryRestUrl: https://remotebuildexecution.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/remote-build-execution/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: remotebuildexecution:v2 + kind: discovery#directoryItem + name: remotebuildexecution + preferred: true + service: + $ref: googleapis.com/v1/services/remotebuildexecution-v2.yaml + title: Remote Build Execution API + version: v2 + remotebuildexecution:v1: + description: Supplies a Remote Execution API service for tools such as bazel. + discoveryRestUrl: https://remotebuildexecution.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/remote-build-execution/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: remotebuildexecution:v1 + kind: discovery#directoryItem + name: remotebuildexecution + preferred: false + title: Remote Build Execution API + version: v1 + remotebuildexecution:v1alpha: + description: Supplies a Remote Execution API service for tools such as bazel. + discoveryRestUrl: https://remotebuildexecution.googleapis.com/services/$discovery-rest?version=v1alpha + documentationLink: https://cloud.google.com/remote-build-execution/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: remotebuildexecution:v1alpha + kind: discovery#directoryItem + name: remotebuildexecution + preferred: false + title: Remote Build Execution API + version: v1alpha + reseller: + description: Creates and manages your customers and their subscriptions. + discoveryLink: ./apis/reseller/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/reseller/v1-rest + documentationLink: https://developers.google.com/google-apps/reseller/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: reseller:v1 + kind: discovery#directoryItem + labels: + - limited_availability + name: reseller + preferred: true + service: + $ref: googleapis.com/v1/services/reseller-v1.yaml + title: Enterprise Apps Reseller API + version: v1 + run: + description: Deploy and manage user provided container images that scale automatically + based on HTTP traffic. + discoveryRestUrl: https://run.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/run/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: run:v1 + kind: discovery#directoryItem + name: run + preferred: true + service: + $ref: googleapis.com/v1/services/run-v1.yaml + title: Cloud Run Admin API + version: v1 + run:v1alpha1: + description: Deploy and manage user provided container images that scale automatically + based on HTTP traffic. + discoveryRestUrl: https://run.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://cloud.google.com/run/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: run:v1alpha1 + kind: discovery#directoryItem + name: run + preferred: false + title: Cloud Run Admin API + version: v1alpha1 + run:v1beta1: + description: Deploy and manage user provided container images that scale automatically + based on HTTP traffic. + discoveryRestUrl: https://run.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/run/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: run:v1beta1 + kind: discovery#directoryItem + name: run + preferred: false + title: Cloud Run Admin API + version: v1beta1 + runtimeconfig: + description: The Runtime Configurator allows you to dynamically configure and + expose variables through Google Cloud Platform. In addition, you can also set + Watchers and Waiters that will watch for changes to your data and return based + on certain conditions. + discoveryRestUrl: https://runtimeconfig.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/deployment-manager/runtime-configurator/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: runtimeconfig:v1 + kind: discovery#directoryItem + name: runtimeconfig + preferred: true + service: + $ref: googleapis.com/v1/services/runtimeconfig-v1.yaml + title: Cloud Runtime Configuration API + version: v1 + runtimeconfig:v1beta1: + description: The Runtime Configurator allows you to dynamically configure and + expose variables through Google Cloud Platform. In addition, you can also set + Watchers and Waiters that will watch for changes to your data and return based + on certain conditions. + discoveryRestUrl: https://runtimeconfig.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/deployment-manager/runtime-configurator/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: runtimeconfig:v1beta1 + kind: discovery#directoryItem + name: runtimeconfig + preferred: false + title: Cloud Runtime Configuration API + version: v1beta1 + safebrowsing: + description: "Enables client applications to check web resources (most commonly\ + \ URLs) against Google-generated lists of unsafe web resources. The Safe Browsing\ + \ APIs are for non-commercial use only. If you need to use APIs to detect malicious\ + \ URLs for commercial purposes \u2013 meaning \u201Cfor sale or revenue-generating\ + \ purposes\u201D \u2013 please refer to the Web Risk API." + discoveryRestUrl: https://safebrowsing.googleapis.com/services/$discovery-rest?version=v4 + documentationLink: https://developers.google.com/safe-browsing/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: safebrowsing:v4 + kind: discovery#directoryItem + name: safebrowsing + preferred: true + service: + $ref: googleapis.com/v1/services/safebrowsing-v4.yaml + title: Safe Browsing API + version: v4 + sasportal: + description: '' + discoveryRestUrl: https://sasportal.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://developers.google.com/spectrum-access-system/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: sasportal:v1alpha1 + kind: discovery#directoryItem + name: sasportal + preferred: true + service: + $ref: googleapis.com/v1/services/sasportal-v1alpha1.yaml + title: SAS Portal API + version: v1alpha1 + script: + description: Manages and executes Google Apps Script projects. + discoveryRestUrl: https://script.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/apps-script/api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: script:v1 + kind: discovery#directoryItem + name: script + preferred: true + service: + $ref: googleapis.com/v1/services/script-v1.yaml + title: Apps Script API + version: v1 + searchconsole: + description: The Search Console API provides access to both Search Console data + (verified users only) and to public information on an URL basis (anyone) + discoveryRestUrl: https://searchconsole.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/webmaster-tools/search-console-api/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: searchconsole:v1 + kind: discovery#directoryItem + name: searchconsole + preferred: true + service: + $ref: googleapis.com/v1/services/searchconsole-v1.yaml + title: Google Search Console API + version: v1 + secretmanager: + description: Stores sensitive data such as API keys, passwords, and certificates. + Provides convenience while improving security. + discoveryRestUrl: https://secretmanager.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/secret-manager/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: secretmanager:v1 + kind: discovery#directoryItem + name: secretmanager + preferred: true + service: + $ref: googleapis.com/v1/services/secretmanager-v1.yaml + title: Secret Manager API + version: v1 + secretmanager:v1beta1: + description: Stores sensitive data such as API keys, passwords, and certificates. + Provides convenience while improving security. + discoveryRestUrl: https://secretmanager.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/secret-manager/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: secretmanager:v1beta1 + kind: discovery#directoryItem + name: secretmanager + preferred: false + title: Secret Manager API + version: v1beta1 + securitycenter: + description: Security Command Center API provides access to temporal views of + assets and findings within an organization. + discoveryRestUrl: https://securitycenter.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: securitycenter:v1 + kind: discovery#directoryItem + name: securitycenter + preferred: true + service: + $ref: googleapis.com/v1/services/securitycenter-v1.yaml + title: Security Command Center API + version: v1 + securitycenter:v1beta1: + description: Security Command Center API provides access to temporal views of + assets and findings within an organization. + discoveryRestUrl: https://securitycenter.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: securitycenter:v1beta1 + kind: discovery#directoryItem + name: securitycenter + preferred: false + title: Security Command Center API + version: v1beta1 + securitycenter:v1beta2: + description: Security Command Center API provides access to temporal views of + assets and findings within an organization. + discoveryRestUrl: https://securitycenter.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: securitycenter:v1beta2 + kind: discovery#directoryItem + name: securitycenter + preferred: false + title: Security Command Center API + version: v1beta2 + securitycenter:v1p1alpha1: + description: Security Command Center API provides access to temporal views of + assets and findings within an organization. + discoveryRestUrl: https://securitycenter.googleapis.com/services/$discovery-rest?version=v1p1alpha1 + documentationLink: https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: securitycenter:v1p1alpha1 + kind: discovery#directoryItem + name: securitycenter + preferred: false + title: Security Command Center API + version: v1p1alpha1 + securitycenter:v1p1beta1: + description: Security Command Center API provides access to temporal views of + assets and findings within an organization. + discoveryRestUrl: https://securitycenter.googleapis.com/services/$discovery-rest?version=v1p1beta1 + documentationLink: https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: securitycenter:v1p1beta1 + kind: discovery#directoryItem + name: securitycenter + preferred: false + title: Security Command Center API + version: v1p1beta1 + serviceconsumermanagement: + description: Manages the service consumers of a Service Infrastructure service. + discoveryRestUrl: https://serviceconsumermanagement.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/service-consumer-management/docs/overview + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: serviceconsumermanagement:v1 + kind: discovery#directoryItem + name: serviceconsumermanagement + preferred: true + service: + $ref: googleapis.com/v1/services/serviceconsumermanagement-v1.yaml + title: Service Consumer Management API + version: v1 + serviceconsumermanagement:v1beta1: + description: Manages the service consumers of a Service Infrastructure service. + discoveryRestUrl: https://serviceconsumermanagement.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/service-consumer-management/docs/overview + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: serviceconsumermanagement:v1beta1 + kind: discovery#directoryItem + name: serviceconsumermanagement + preferred: false + title: Service Consumer Management API + version: v1beta1 + servicecontrol: + description: Provides control plane functionality to managed services, such as + logging, monitoring, and status checks. + discoveryRestUrl: https://servicecontrol.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/service-control/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: servicecontrol:v2 + kind: discovery#directoryItem + name: servicecontrol + preferred: true + service: + $ref: googleapis.com/v1/services/servicecontrol-v2.yaml + title: Service Control API + version: v2 + servicecontrol:v1: + description: Provides control plane functionality to managed services, such as + logging, monitoring, and status checks. + discoveryRestUrl: https://servicecontrol.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/service-control/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: servicecontrol:v1 + kind: discovery#directoryItem + name: servicecontrol + preferred: false + title: Service Control API + version: v1 + servicedirectory: + description: Service Directory is a platform for discovering, publishing, and + connecting services. + discoveryRestUrl: https://servicedirectory.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/service-directory + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: servicedirectory:v1beta1 + kind: discovery#directoryItem + name: servicedirectory + preferred: true + service: + $ref: googleapis.com/v1/services/servicedirectory-v1beta1.yaml + title: Service Directory API + version: v1beta1 + servicemanagement: + description: Google Service Management allows service producers to publish their + services on Google Cloud Platform so that they can be discovered and used by + service consumers. + discoveryRestUrl: https://servicemanagement.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/service-management/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: servicemanagement:v1 + kind: discovery#directoryItem + name: servicemanagement + preferred: true + service: + $ref: googleapis.com/v1/services/servicemanagement-v1.yaml + title: Service Management API + version: v1 + servicenetworking: + description: Provides automatic management of network configurations necessary + for certain services. + discoveryRestUrl: https://servicenetworking.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: servicenetworking:v1 + kind: discovery#directoryItem + name: servicenetworking + preferred: true + service: + $ref: googleapis.com/v1/services/servicenetworking-v1.yaml + title: Service Networking API + version: v1 + servicenetworking:v1beta: + description: Provides automatic management of network configurations necessary + for certain services. + discoveryRestUrl: https://servicenetworking.googleapis.com/services/$discovery-rest?version=v1beta + documentationLink: https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: servicenetworking:v1beta + kind: discovery#directoryItem + name: servicenetworking + preferred: false + title: Service Networking API + version: v1beta + serviceusage: + description: Enables services that service consumers want to use on Google Cloud + Platform, lists the available or enabled services, or disables services that + service consumers no longer use. + discoveryRestUrl: https://serviceusage.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/service-usage/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: serviceusage:v1 + kind: discovery#directoryItem + name: serviceusage + preferred: true + service: + $ref: googleapis.com/v1/services/serviceusage-v1.yaml + title: Service Usage API + version: v1 + serviceusage:v1beta1: + description: Enables services that service consumers want to use on Google Cloud + Platform, lists the available or enabled services, or disables services that + service consumers no longer use. + discoveryRestUrl: https://serviceusage.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/service-usage/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: serviceusage:v1beta1 + kind: discovery#directoryItem + name: serviceusage + preferred: false + title: Service Usage API + version: v1beta1 + sheets: + description: Reads and writes Google Sheets. + discoveryRestUrl: https://sheets.googleapis.com/services/$discovery-rest?version=v4 + documentationLink: https://developers.google.com/sheets/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: sheets:v4 + kind: discovery#directoryItem + name: sheets + preferred: true + service: + $ref: googleapis.com/v1/services/sheets-v4.yaml + title: Google Sheets API + version: v4 + siteVerification: + description: Verifies ownership of websites or domains with Google. + discoveryLink: ./apis/siteVerification/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/siteVerification/v1-rest + documentationLink: https://developers.google.com/site-verification/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: siteVerification:v1 + kind: discovery#directoryItem + name: siteVerification + preferred: true + service: + $ref: googleapis.com/v1/services/siteVerification-v1.yaml + title: Google Site Verification API + version: v1 + slides: + description: Reads and writes Google Slides presentations. + discoveryRestUrl: https://slides.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/slides/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: slides:v1 + kind: discovery#directoryItem + name: slides + preferred: true + service: + $ref: googleapis.com/v1/services/slides-v1.yaml + title: Google Slides API + version: v1 + sourcerepo: + description: Accesses source code repositories hosted by Google. + discoveryRestUrl: https://sourcerepo.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/source-repositories/docs/apis + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: sourcerepo:v1 + kind: discovery#directoryItem + name: sourcerepo + preferred: true + service: + $ref: googleapis.com/v1/services/sourcerepo-v1.yaml + title: Cloud Source Repositories API + version: v1 + spanner: + description: Cloud Spanner is a managed, mission-critical, globally consistent + and scalable relational database service. + discoveryRestUrl: https://spanner.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/spanner/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: spanner:v1 + kind: discovery#directoryItem + name: spanner + preferred: true + service: + $ref: googleapis.com/v1/services/spanner-v1.yaml + title: Cloud Spanner API + version: v1 + speech: + description: Converts audio to text by applying powerful neural network models. + discoveryRestUrl: https://speech.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/speech-to-text/docs/quickstart-protocol + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: speech:v1 + kind: discovery#directoryItem + name: speech + preferred: true + service: + $ref: googleapis.com/v1/services/speech-v1.yaml + title: Cloud Speech-to-Text API + version: v1 + speech:v1p1beta1: + description: Converts audio to text by applying powerful neural network models. + discoveryRestUrl: https://speech.googleapis.com/services/$discovery-rest?version=v1p1beta1 + documentationLink: https://cloud.google.com/speech-to-text/docs/quickstart-protocol + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: speech:v1p1beta1 + kind: discovery#directoryItem + name: speech + preferred: false + title: Cloud Speech-to-Text API + version: v1p1beta1 + speech:v2beta1: + description: Converts audio to text by applying powerful neural network models. + discoveryRestUrl: https://speech.googleapis.com/services/$discovery-rest?version=v2beta1 + documentationLink: https://cloud.google.com/speech-to-text/docs/quickstart-protocol + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: speech:v2beta1 + kind: discovery#directoryItem + name: speech + preferred: false + title: Cloud Speech-to-Text API + version: v2beta1 + sql: + description: API for Cloud SQL database instance management + discoveryRestUrl: https://sqladmin.googleapis.com/services/$discovery-rest?version=v1beta4 + documentationLink: https://developers.google.com/cloud-sql/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: sql:v1beta4 + kind: discovery#directoryItem + name: sql + preferred: true + service: + $ref: googleapis.com/v1/services/sql-v1beta4.yaml + title: Cloud SQL Admin API + version: v1beta4 + storage: + description: Stores and retrieves potentially large, immutable data objects. + discoveryLink: ./apis/storage/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/storage/v1-rest + documentationLink: https://developers.google.com/storage/docs/json_api/ + 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 + id: storage:v1 + kind: discovery#directoryItem + labels: + - labs + name: storage + preferred: true + service: + $ref: googleapis.com/v1/services/storage-v1.yaml + title: Cloud Storage JSON API + version: v1 + storage:v1beta2: + description: Lets you store and retrieve potentially-large, immutable data objects. + discoveryLink: ./apis/storage/v1beta2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/storage/v1beta2-rest + documentationLink: https://developers.google.com/storage/docs/json_api/ + 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 + id: storage:v1beta2 + kind: discovery#directoryItem + labels: + - labs + name: storage + preferred: false + title: Cloud Storage JSON API + version: v1beta2 + storagetransfer: + description: Transfers data from external data sources to a Google Cloud Storage + bucket or between Google Cloud Storage buckets. + discoveryRestUrl: https://storagetransfer.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/storage-transfer/docs + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: storagetransfer:v1 + kind: discovery#directoryItem + name: storagetransfer + preferred: true + service: + $ref: googleapis.com/v1/services/storagetransfer-v1.yaml + title: Storage Transfer API + version: v1 + streetviewpublish: + description: Publishes 360 photos to Google Maps, along with position, orientation, + and connectivity metadata. Apps can offer an interface for positioning, connecting, + and uploading user-generated Street View images. + discoveryRestUrl: https://streetviewpublish.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/streetview/publish/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: streetviewpublish:v1 + kind: discovery#directoryItem + name: streetviewpublish + preferred: true + service: + $ref: googleapis.com/v1/services/streetviewpublish-v1.yaml + title: Street View Publish API + version: v1 + tagmanager: + description: Accesses Tag Manager accounts and containers. + discoveryLink: ./apis/tagmanager/v2/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/tagmanager/v2-rest + documentationLink: https://developers.google.com/tag-manager/api/v2/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: tagmanager:v2 + kind: discovery#directoryItem + name: tagmanager + preferred: true + service: + $ref: googleapis.com/v1/services/tagmanager-v2.yaml + title: Tag Manager API + version: v2 + tagmanager:v1: + description: Accesses Tag Manager accounts and containers. + discoveryLink: ./apis/tagmanager/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/tagmanager/v1-rest + documentationLink: https://developers.google.com/tag-manager/api/v1/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: tagmanager:v1 + kind: discovery#directoryItem + name: tagmanager + preferred: false + title: Tag Manager API + version: v1 + tasks: + description: Manages your tasks and task lists. + discoveryLink: ./apis/tasks/v1/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/tasks/v1-rest + documentationLink: https://developers.google.com/google-apps/tasks/firstapp + icons: + x16: https://www.google.com/images/icons/product/tasks-16.png + x32: https://www.google.com/images/icons/product/tasks-32.png + id: tasks:v1 + kind: discovery#directoryItem + name: tasks + preferred: true + service: + $ref: googleapis.com/v1/services/tasks-v1.yaml + title: Tasks API + version: v1 + testing: + description: Allows developers to run automated tests for their mobile applications + on Google infrastructure. + discoveryRestUrl: https://testing.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/cloud-test-lab/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: testing:v1 + kind: discovery#directoryItem + name: testing + preferred: true + service: + $ref: googleapis.com/v1/services/testing-v1.yaml + title: Cloud Testing API + version: v1 + texttospeech: + description: Synthesizes natural-sounding speech by applying powerful neural network + models. + discoveryRestUrl: https://texttospeech.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/text-to-speech/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: texttospeech:v1 + kind: discovery#directoryItem + name: texttospeech + preferred: true + service: + $ref: googleapis.com/v1/services/texttospeech-v1.yaml + title: Cloud Text-to-Speech API + version: v1 + texttospeech:v1beta1: + description: Synthesizes natural-sounding speech by applying powerful neural network + models. + discoveryRestUrl: https://texttospeech.googleapis.com/services/$discovery-rest?version=v1beta1 + documentationLink: https://cloud.google.com/text-to-speech/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: texttospeech:v1beta1 + kind: discovery#directoryItem + name: texttospeech + preferred: false + title: Cloud Text-to-Speech API + version: v1beta1 + toolresults: + description: API to publish and access results from developer tools. + discoveryRestUrl: https://toolresults.googleapis.com/services/$discovery-rest?version=v1beta3 + documentationLink: https://firebase.google.com/docs/test-lab/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: toolresults:v1beta3 + kind: discovery#directoryItem + name: toolresults + preferred: true + service: + $ref: googleapis.com/v1/services/toolresults-v1beta3.yaml + title: Cloud Tool Results API + version: v1beta3 + tpu: + description: TPU API provides customers with access to Google TPU technology. + discoveryRestUrl: https://tpu.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/tpu/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: tpu:v1 + kind: discovery#directoryItem + name: tpu + preferred: true + service: + $ref: googleapis.com/v1/services/tpu-v1.yaml + title: Cloud TPU API + version: v1 + tpu:v1alpha1: + description: TPU API provides customers with access to Google TPU technology. + discoveryRestUrl: https://tpu.googleapis.com/services/$discovery-rest?version=v1alpha1 + documentationLink: https://cloud.google.com/tpu/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: tpu:v1alpha1 + kind: discovery#directoryItem + name: tpu + preferred: false + title: Cloud TPU API + version: v1alpha1 + trafficdirector: + description: '' + discoveryRestUrl: https://trafficdirector.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://www.envoyproxy.io/docs/envoy/latest/configuration/overview/v2_overview#management-server + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: trafficdirector:v2 + kind: discovery#directoryItem + name: trafficdirector + preferred: true + service: + $ref: googleapis.com/v1/services/trafficdirector-v2.yaml + title: Traffic Director API + version: v2 + translate: + description: Integrates text translation into your website or application. + discoveryRestUrl: https://translation.googleapis.com/services/$discovery-rest?version=v3 + documentationLink: https://cloud.google.com/translate/docs/quickstarts + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: translate:v3 + kind: discovery#directoryItem + name: translate + preferred: true + service: + $ref: googleapis.com/v1/services/translate-v3.yaml + title: Cloud Translation API + version: v3 + translate:v2: + description: Integrates text translation into your website or application. + discoveryRestUrl: https://translation.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://cloud.google.com/translate/docs/quickstarts + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: translate:v2 + kind: discovery#directoryItem + name: translate + preferred: false + title: Cloud Translation API + version: v2 + translate:v3beta1: + description: Integrates text translation into your website or application. + discoveryRestUrl: https://translation.googleapis.com/services/$discovery-rest?version=v3beta1 + documentationLink: https://cloud.google.com/translate/docs/quickstarts + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: translate:v3beta1 + kind: discovery#directoryItem + name: translate + preferred: false + title: Cloud Translation API + version: v3beta1 + vault: + description: Archiving and eDiscovery for G Suite. + discoveryRestUrl: https://vault.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/vault + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: vault:v1 + kind: discovery#directoryItem + name: vault + preferred: true + service: + $ref: googleapis.com/v1/services/vault-v1.yaml + title: G Suite Vault API + version: v1 + vectortile: + description: Serves vector tiles containing geospatial data. + discoveryRestUrl: https://vectortile.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/maps/contact-sales/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: vectortile:v1 + kind: discovery#directoryItem + name: vectortile + preferred: true + service: + $ref: googleapis.com/v1/services/vectortile-v1.yaml + title: Semantic Tile API + version: v1 + verifiedaccess: + description: API for Verified Access chrome extension to provide credential verification + for chrome devices connecting to an enterprise network + discoveryRestUrl: https://verifiedaccess.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/chrome/verified-access + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: verifiedaccess:v1 + kind: discovery#directoryItem + name: verifiedaccess + preferred: true + service: + $ref: googleapis.com/v1/services/verifiedaccess-v1.yaml + title: Chrome Verified Access API + version: v1 + videointelligence: + description: Detects objects, explicit content, and scene changes in videos. It + also specifies the region for annotation and transcribes speech to text. Supports + both asynchronous API and streaming API. + discoveryRestUrl: https://videointelligence.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/video-intelligence/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: videointelligence:v1 + kind: discovery#directoryItem + name: videointelligence + preferred: true + service: + $ref: googleapis.com/v1/services/videointelligence-v1.yaml + title: Cloud Video Intelligence API + version: v1 + videointelligence:v1beta2: + description: Detects objects, explicit content, and scene changes in videos. It + also specifies the region for annotation and transcribes speech to text. Supports + both asynchronous API and streaming API. + discoveryRestUrl: https://videointelligence.googleapis.com/services/$discovery-rest?version=v1beta2 + documentationLink: https://cloud.google.com/video-intelligence/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: videointelligence:v1beta2 + kind: discovery#directoryItem + name: videointelligence + preferred: false + title: Cloud Video Intelligence API + version: v1beta2 + videointelligence:v1p1beta1: + description: Detects objects, explicit content, and scene changes in videos. It + also specifies the region for annotation and transcribes speech to text. Supports + both asynchronous API and streaming API. + discoveryRestUrl: https://videointelligence.googleapis.com/services/$discovery-rest?version=v1p1beta1 + documentationLink: https://cloud.google.com/video-intelligence/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: videointelligence:v1p1beta1 + kind: discovery#directoryItem + name: videointelligence + preferred: false + title: Cloud Video Intelligence API + version: v1p1beta1 + videointelligence:v1p2beta1: + description: Detects objects, explicit content, and scene changes in videos. It + also specifies the region for annotation and transcribes speech to text. Supports + both asynchronous API and streaming API. + discoveryRestUrl: https://videointelligence.googleapis.com/services/$discovery-rest?version=v1p2beta1 + documentationLink: https://cloud.google.com/video-intelligence/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: videointelligence:v1p2beta1 + kind: discovery#directoryItem + name: videointelligence + preferred: false + title: Cloud Video Intelligence API + version: v1p2beta1 + videointelligence:v1p3beta1: + description: Detects objects, explicit content, and scene changes in videos. It + also specifies the region for annotation and transcribes speech to text. Supports + both asynchronous API and streaming API. + discoveryRestUrl: https://videointelligence.googleapis.com/services/$discovery-rest?version=v1p3beta1 + documentationLink: https://cloud.google.com/video-intelligence/docs/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: videointelligence:v1p3beta1 + kind: discovery#directoryItem + name: videointelligence + preferred: false + title: Cloud Video Intelligence API + version: v1p3beta1 + vision: + description: Integrates Google Vision features, including image labeling, face, + logo, and landmark detection, optical character recognition (OCR), and detection + of explicit content, into applications. + discoveryRestUrl: https://vision.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/vision/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: vision:v1 + kind: discovery#directoryItem + name: vision + preferred: true + service: + $ref: googleapis.com/v1/services/vision-v1.yaml + title: Cloud Vision API + version: v1 + vision:v1p1beta1: + description: Integrates Google Vision features, including image labeling, face, + logo, and landmark detection, optical character recognition (OCR), and detection + of explicit content, into applications. + discoveryRestUrl: https://vision.googleapis.com/services/$discovery-rest?version=v1p1beta1 + documentationLink: https://cloud.google.com/vision/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: vision:v1p1beta1 + kind: discovery#directoryItem + name: vision + preferred: false + title: Cloud Vision API + version: v1p1beta1 + vision:v1p2beta1: + description: Integrates Google Vision features, including image labeling, face, + logo, and landmark detection, optical character recognition (OCR), and detection + of explicit content, into applications. + discoveryRestUrl: https://vision.googleapis.com/services/$discovery-rest?version=v1p2beta1 + documentationLink: https://cloud.google.com/vision/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: vision:v1p2beta1 + kind: discovery#directoryItem + name: vision + preferred: false + title: Cloud Vision API + version: v1p2beta1 + webmasters: + description: View Google Search Console data for your verified sites. + discoveryLink: ./apis/webmasters/v3/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/webmasters/v3-rest + documentationLink: https://developers.google.com/webmaster-tools/ + icons: + x16: https://www.google.com/images/icons/product/webmaster_tools-16.png + x32: https://www.google.com/images/icons/product/webmaster_tools-32.png + id: webmasters:v3 + kind: discovery#directoryItem + name: webmasters + preferred: true + service: + $ref: googleapis.com/v1/services/webmasters-v3.yaml + title: Search Console API + version: v3 + websecurityscanner: + description: Scans your Compute and App Engine apps for common web vulnerabilities. + discoveryRestUrl: https://websecurityscanner.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: websecurityscanner:v1 + kind: discovery#directoryItem + name: websecurityscanner + preferred: true + service: + $ref: googleapis.com/v1/services/websecurityscanner-v1.yaml + title: Web Security Scanner API + version: v1 + websecurityscanner:v1alpha: + description: Scans your Compute and App Engine apps for common web vulnerabilities. + discoveryRestUrl: https://websecurityscanner.googleapis.com/services/$discovery-rest?version=v1alpha + documentationLink: https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: websecurityscanner:v1alpha + kind: discovery#directoryItem + name: websecurityscanner + preferred: false + title: Web Security Scanner API + version: v1alpha + websecurityscanner:v1beta: + description: Scans your Compute and App Engine apps for common web vulnerabilities. + discoveryRestUrl: https://websecurityscanner.googleapis.com/services/$discovery-rest?version=v1beta + documentationLink: https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: websecurityscanner:v1beta + kind: discovery#directoryItem + name: websecurityscanner + preferred: false + title: Web Security Scanner API + version: v1beta + youtube: + description: Supports core YouTube features, such as uploading videos, creating + and managing playlists, searching for content, and much more. + discoveryLink: ./apis/youtube/v3/rest + discoveryRestUrl: https://www.googleapis.com/services/discovery/v1/apis/youtube/v3-rest + documentationLink: https://developers.google.com/youtube/v3 + icons: + x16: https://www.google.com/images/icons/product/youtube-16.png + x32: https://www.google.com/images/icons/product/youtube-32.png + id: youtube:v3 + kind: discovery#directoryItem + name: youtube + preferred: true + service: + $ref: googleapis.com/v1/services/youtube-v3.yaml + title: YouTube Data API + version: v3 + youtubeAnalytics: + description: Retrieves your YouTube Analytics data. + discoveryRestUrl: https://youtubeanalytics.googleapis.com/services/$discovery-rest?version=v2 + documentationLink: https://developers.google.com/youtube/analytics + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: youtubeAnalytics:v2 + kind: discovery#directoryItem + name: youtubeAnalytics + preferred: true + service: + $ref: googleapis.com/v1/services/youtubeAnalytics-v2.yaml + title: YouTube Analytics API + version: v2 + youtubeAnalytics:v1: + description: Retrieves your YouTube Analytics data. + discoveryRestUrl: https://youtubeanalytics.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/youtube/analytics + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: youtubeAnalytics:v1 + kind: discovery#directoryItem + name: youtubeAnalytics + preferred: false + title: YouTube Analytics API + version: v1 + youtubereporting: + description: Schedules reporting jobs containing your YouTube Analytics data and + downloads the resulting bulk data reports in the form of CSV files. + discoveryRestUrl: https://youtubereporting.googleapis.com/services/$discovery-rest?version=v1 + documentationLink: https://developers.google.com/youtube/reporting/v1/reports/ + icons: + x16: https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png + x32: https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png + id: youtubereporting:v1 + kind: discovery#directoryItem + name: youtubereporting + preferred: true + service: + $ref: googleapis.com/v1/services/youtubereporting-v1.yaml + title: YouTube Reporting API + version: v1 +title: google +version: v1 diff --git a/test/registry/src/googleapis.com/v1/provider.yaml.sig b/test/registry/src/googleapis.com/v1/provider.yaml.sig new file mode 100644 index 00000000..010a55eb --- /dev/null +++ b/test/registry/src/googleapis.com/v1/provider.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELaEzpVMAKUp/EzvNIF+1QyCv9NInOyXhnrFE557ZhVB6fVRdK+QVImAPgcvgEJzbbYes9wIoJk7MimFOLWRhr/DY1hiumqBQ== \ No newline at end of file diff --git a/test/registry/src/googleapis.com/v1/resources/compute-v1.yaml b/test/registry/src/googleapis.com/v1/resources/compute-v1.yaml new file mode 100644 index 00000000..b5878dd6 --- /dev/null +++ b/test/registry/src/googleapis.com/v1/resources/compute-v1.yaml @@ -0,0 +1,5722 @@ +serviceDoc: + $ref: googleapis.com/v1/services-split/compute/compute-v1.yaml +resources: + acceleratorTypes: + id: google.compute.acceleratorTypes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/acceleratorTypes + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/acceleratorTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: acceleratorTypes + title: acceleratorTypes + addresses: + id: google.compute.addresses + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/addresses + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/addresses/{address} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/addresses/{address} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/addresses + request: + mediaType: application/json + required: + - name + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/addresses + response: + mediaType: application/json + openAPIDocKey: '200' + name: addresses + title: addresses + autoscalers: + id: google.compute.autoscalers + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/autoscalers + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/autoscalers/{autoscaler} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/autoscalers/{autoscaler} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/autoscalers + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/zones/{zone}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: autoscalers + title: autoscalers + backendBuckets: + id: google.compute.backendBuckets + methods: + addSignedUrlKey: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteSignedUrlKey: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendBuckets + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/backendBuckets + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: backendBuckets + title: backendBuckets + backendServices: + id: google.compute.backendServices + methods: + addSignedUrlKey: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices/{backendService}/addSignedUrlKey + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/backendServices + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/backendServices/{backendService} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteSignedUrlKey: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/backendServices/{backendService} + response: + mediaType: application/json + openAPIDocKey: '200' + getHealth: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices/{backendService}/getHealth + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/backendServices + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/backendServices/{backendService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSecurityPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices/{backendService}/setSecurityPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/backendServices/{backendService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: backendServices + title: backendServices + diskTypes: + id: google.compute.diskTypes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/diskTypes + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/diskTypes/{diskType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/diskTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: diskTypes + title: diskTypes + disks: + id: google.compute.disks + serviceDoc: + $ref: googleapis.com/v1/services-split/compute/compute-disks-v1.yaml + methods: + addResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/disks + response: + mediaType: application/json + openAPIDocKey: '200' + createSnapshot: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk}/createSnapshot + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/disks + response: + mediaType: application/json + openAPIDocKey: '200' + removeResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk}/resize + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: disks + title: disks + externalVpnGateways: + id: google.compute.externalVpnGateways + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/externalVpnGateways/{externalVpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/externalVpnGateways/{externalVpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/externalVpnGateways + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/externalVpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/global/externalVpnGateways/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: externalVpnGateways + title: externalVpnGateways + firewallPolicies: + id: google.compute.firewallPolicies + methods: + addAssociation: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/addAssociation + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + addRule: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/addRule + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + cloneRules: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/cloneRules + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + getAssociation: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/getAssociation + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + getRule: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/getRule + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies + response: + mediaType: application/json + openAPIDocKey: '200' + listAssociations: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/listAssociations + response: + mediaType: application/json + openAPIDocKey: '200' + move: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/move + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patchRule: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/patchRule + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removeAssociation: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/removeAssociation + response: + mediaType: application/json + openAPIDocKey: '200' + removeRule: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/removeRule + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: firewallPolicies + title: firewallPolicies + firewalls: + id: google.compute.firewalls + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/firewalls/{firewall} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/firewalls/{firewall} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/firewalls + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/firewalls + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/firewalls/{firewall} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/firewalls/{firewall} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: firewalls + title: firewalls + forwardingRules: + id: google.compute.forwardingRules + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/forwardingRules + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{forwardingRule} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{forwardingRule} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/forwardingRules + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/forwardingRules + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{forwardingRule} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTarget: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: forwardingRules + title: forwardingRules + globalAddresses: + id: google.compute.globalAddresses + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/addresses/{address} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/addresses/{address} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/addresses + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/addresses + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalAddresses + title: globalAddresses + globalForwardingRules: + id: google.compute.globalForwardingRules + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/forwardingRules/{forwardingRule} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/forwardingRules/{forwardingRule} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/forwardingRules + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/forwardingRules + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/forwardingRules/{forwardingRule} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/global/forwardingRules/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTarget: + operation: + $ref: post + path: + $ref: /projects/{project}/global/forwardingRules/{forwardingRule}/setTarget + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalForwardingRules + title: globalForwardingRules + globalNetworkEndpointGroups: + id: google.compute.globalNetworkEndpointGroups + methods: + attachNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + detachNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networkEndpointGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networkEndpointGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalNetworkEndpointGroups + title: globalNetworkEndpointGroups + globalOperations: + id: google.compute.globalOperations + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/operations + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/operations/{operation} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/operations/{operation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/operations + response: + mediaType: application/json + openAPIDocKey: '200' + wait: + operation: + $ref: post + path: + $ref: /projects/{project}/global/operations/{operation}/wait + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalOperations + title: globalOperations + globalOrganizationOperations: + id: google.compute.globalOrganizationOperations + methods: + delete: + operation: + $ref: delete + path: + $ref: /locations/global/operations/{operation} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /locations/global/operations/{operation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /locations/global/operations + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalOrganizationOperations + title: globalOrganizationOperations + globalPublicDelegatedPrefixes: + id: google.compute.globalPublicDelegatedPrefixes + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalPublicDelegatedPrefixes + title: globalPublicDelegatedPrefixes + healthChecks: + id: google.compute.healthChecks + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/healthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/healthChecks/{healthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/healthChecks/{healthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/healthChecks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/healthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/healthChecks/{healthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/healthChecks/{healthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: healthChecks + title: healthChecks + httpHealthChecks: + id: google.compute.httpHealthChecks + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/httpHealthChecks/{httpHealthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/httpHealthChecks/{httpHealthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/httpHealthChecks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/httpHealthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/httpHealthChecks/{httpHealthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/httpHealthChecks/{httpHealthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: httpHealthChecks + title: httpHealthChecks + httpsHealthChecks: + id: google.compute.httpsHealthChecks + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/httpsHealthChecks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/httpsHealthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: httpsHealthChecks + title: httpsHealthChecks + imageFamilyViews: + id: google.compute.imageFamilyViews + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/imageFamilyViews/{family} + response: + mediaType: application/json + openAPIDocKey: '200' + name: imageFamilyViews + title: imageFamilyViews + images: + id: google.compute.images + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/images/{image} + response: + mediaType: application/json + openAPIDocKey: '200' + deprecate: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images/{image}/deprecate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/images/{image} + response: + mediaType: application/json + openAPIDocKey: '200' + getFromFamily: + operation: + $ref: get + path: + $ref: /projects/{project}/global/images/family/{family} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/global/images/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/images + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/images/{image} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: images + title: images + instanceGroupManagers: + id: google.compute.instanceGroupManagers + methods: + abandonInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/instanceGroupManagers + response: + mediaType: application/json + openAPIDocKey: '200' + applyUpdatesToInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + createInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + deletePerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers + response: + mediaType: application/json + openAPIDocKey: '200' + listErrors: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors + response: + mediaType: application/json + openAPIDocKey: '200' + listManagedInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances + response: + mediaType: application/json + openAPIDocKey: '200' + listPerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patchPerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + recreateInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize + response: + mediaType: application/json + openAPIDocKey: '200' + setInstanceTemplate: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTargetPools: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updatePerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: instanceGroupManagers + title: instanceGroupManagers + instanceGroups: + id: google.compute.instanceGroups + methods: + addInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/instanceGroups + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removeInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setNamedPorts: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: instanceGroups + title: instanceGroups + instanceTemplates: + id: google.compute.instanceTemplates + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/instanceTemplates/{instanceTemplate} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/instanceTemplates/{instanceTemplate} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/global/instanceTemplates/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/instanceTemplates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/instanceTemplates + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/instanceTemplates/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/instanceTemplates/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: instanceTemplates + title: instanceTemplates + instances: + id: google.compute.instances + methods: + addAccessConfig: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + addResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/instances + response: + mediaType: application/json + openAPIDocKey: '200' + attachDisk: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/attachDisk + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + bulkInsert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/bulkInsert + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteAccessConfig: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig + response: + mediaType: application/json + openAPIDocKey: '200' + detachDisk: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/detachDisk + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance} + response: + mediaType: application/json + openAPIDocKey: '200' + getEffectiveFirewalls: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls + response: + mediaType: application/json + openAPIDocKey: '200' + getGuestAttributes: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + getScreenshot: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/screenshot + response: + mediaType: application/json + openAPIDocKey: '200' + getSerialPortOutput: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/serialPort + response: + mediaType: application/json + openAPIDocKey: '200' + getShieldedInstanceIdentity: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances + response: + mediaType: application/json + openAPIDocKey: '200' + listReferrers: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/referrers + response: + mediaType: application/json + openAPIDocKey: '200' + removeResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + reset: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/reset + response: + mediaType: application/json + openAPIDocKey: '200' + sendDiagnosticInterrupt: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt + response: + openAPIDocKey: '200' + setDeletionProtection: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection + response: + mediaType: application/json + openAPIDocKey: '200' + setDiskAutoDelete: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMachineResources: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setMachineResources + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMachineType: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setMachineType + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMetadata: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setMetadata + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMinCpuPlatform: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setScheduling: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setScheduling + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setServiceAccount: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setShieldedInstanceIntegrityPolicy: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTags: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setTags + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + simulateMaintenanceEvent: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent + response: + mediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/start + response: + mediaType: application/json + openAPIDocKey: '200' + startWithEncryptionKey: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/stop + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateAccessConfig: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateDisplayDevice: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateNetworkInterface: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateShieldedInstanceConfig: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: instances + title: instances + interconnectAttachments: + id: google.compute.interconnectAttachments + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/interconnectAttachments + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: interconnectAttachments + title: interconnectAttachments + interconnectLocations: + id: google.compute.interconnectLocations + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnectLocations/{interconnectLocation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnectLocations + response: + mediaType: application/json + openAPIDocKey: '200' + name: interconnectLocations + title: interconnectLocations + interconnects: + id: google.compute.interconnects + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/interconnects/{interconnect} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnects/{interconnect} + response: + mediaType: application/json + openAPIDocKey: '200' + getDiagnostics: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnects/{interconnect}/getDiagnostics + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/interconnects + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnects + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/interconnects/{interconnect} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: interconnects + title: interconnects + licenseCodes: + id: google.compute.licenseCodes + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/licenseCodes/{licenseCode} + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/licenseCodes/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: licenseCodes + title: licenseCodes + licenses: + id: google.compute.licenses + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/licenses/{license} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/licenses/{license} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/global/licenses/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/licenses + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/licenses + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/licenses/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/licenses/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: licenses + title: licenses + machineTypes: + id: google.compute.machineTypes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/machineTypes + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/machineTypes/{machineType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/machineTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: machineTypes + title: machineTypes + networkEndpointGroups: + id: google.compute.networkEndpointGroups + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/networkEndpointGroups + response: + mediaType: application/json + openAPIDocKey: '200' + attachNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + detachNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: networkEndpointGroups + title: networkEndpointGroups + networks: + id: google.compute.networks + methods: + addPeering: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networks/{network}/addPeering + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/networks/{network} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networks/{network} + response: + mediaType: application/json + openAPIDocKey: '200' + getEffectiveFirewalls: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networks/{network}/getEffectiveFirewalls + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networks + response: + mediaType: application/json + openAPIDocKey: '200' + listPeeringRoutes: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networks/{network}/listPeeringRoutes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/networks/{network} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removePeering: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networks/{network}/removePeering + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + switchToCustomMode: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networks/{network}/switchToCustomMode + response: + mediaType: application/json + openAPIDocKey: '200' + updatePeering: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/networks/{network}/updatePeering + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: networks + title: networks + nodeGroups: + id: google.compute.nodeGroups + methods: + addNodes: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/nodeGroups + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteNodes: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listNodes: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setNodeTemplate: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: nodeGroups + title: nodeGroups + nodeTemplates: + id: google.compute.nodeTemplates + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/nodeTemplates + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: nodeTemplates + title: nodeTemplates + nodeTypes: + id: google.compute.nodeTypes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/nodeTypes + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeTypes/{nodeType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: nodeTypes + title: nodeTypes + packetMirrorings: + id: google.compute.packetMirrorings + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/packetMirrorings + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: packetMirrorings + title: packetMirrorings + projects: + id: google.compute.projects + methods: + disableXpnHost: + operation: + $ref: post + path: + $ref: /projects/{project}/disableXpnHost + response: + mediaType: application/json + openAPIDocKey: '200' + disableXpnResource: + operation: + $ref: post + path: + $ref: /projects/{project}/disableXpnResource + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + enableXpnHost: + operation: + $ref: post + path: + $ref: /projects/{project}/enableXpnHost + response: + mediaType: application/json + openAPIDocKey: '200' + enableXpnResource: + operation: + $ref: post + path: + $ref: /projects/{project}/enableXpnResource + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project} + response: + mediaType: application/json + openAPIDocKey: '200' + getXpnHost: + operation: + $ref: get + path: + $ref: /projects/{project}/getXpnHost + response: + mediaType: application/json + openAPIDocKey: '200' + getXpnResources: + operation: + $ref: get + path: + $ref: /projects/{project}/getXpnResources + response: + mediaType: application/json + openAPIDocKey: '200' + listXpnHosts: + operation: + $ref: post + path: + $ref: /projects/{project}/listXpnHosts + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + moveDisk: + operation: + $ref: post + path: + $ref: /projects/{project}/moveDisk + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + moveInstance: + operation: + $ref: post + path: + $ref: /projects/{project}/moveInstance + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setCommonInstanceMetadata: + operation: + $ref: post + path: + $ref: /projects/{project}/setCommonInstanceMetadata + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setDefaultNetworkTier: + operation: + $ref: post + path: + $ref: /projects/{project}/setDefaultNetworkTier + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setUsageExportBucket: + operation: + $ref: post + path: + $ref: /projects/{project}/setUsageExportBucket + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects + title: projects + publicAdvertisedPrefixes: + id: google.compute.publicAdvertisedPrefixes + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: publicAdvertisedPrefixes + title: publicAdvertisedPrefixes + publicDelegatedPrefixes: + id: google.compute.publicDelegatedPrefixes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/publicDelegatedPrefixes + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: publicDelegatedPrefixes + title: publicDelegatedPrefixes + regionAutoscalers: + id: google.compute.regionAutoscalers + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/autoscalers/{autoscaler} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/autoscalers/{autoscaler} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/autoscalers + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionAutoscalers + title: regionAutoscalers + regionBackendServices: + id: google.compute.regionBackendServices + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService} + response: + mediaType: application/json + openAPIDocKey: '200' + getHealth: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService}/getHealth + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/backendServices + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/backendServices + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionBackendServices + title: regionBackendServices + regionCommitments: + id: google.compute.regionCommitments + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/commitments + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/commitments/{commitment} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/commitments + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/commitments + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionCommitments + title: regionCommitments + regionDiskTypes: + id: google.compute.regionDiskTypes + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/diskTypes/{diskType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/diskTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionDiskTypes + title: regionDiskTypes + regionDisks: + id: google.compute.regionDisks + methods: + addResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + createSnapshot: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{disk}/createSnapshot + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/disks/{disk} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/disks/{disk} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/disks/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/disks + response: + mediaType: application/json + openAPIDocKey: '200' + removeResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{disk}/resize + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionDisks + title: regionDisks + regionHealthCheckServices: + id: google.compute.regionHealthCheckServices + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionHealthCheckServices + title: regionHealthCheckServices + regionHealthChecks: + id: google.compute.regionHealthChecks + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/healthChecks/{healthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/healthChecks/{healthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/healthChecks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/healthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/healthChecks/{healthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/healthChecks/{healthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionHealthChecks + title: regionHealthChecks + regionInstanceGroupManagers: + id: google.compute.regionInstanceGroupManagers + methods: + abandonInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + applyUpdatesToInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + createInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + deletePerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers + response: + mediaType: application/json + openAPIDocKey: '200' + listErrors: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors + response: + mediaType: application/json + openAPIDocKey: '200' + listManagedInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances + response: + mediaType: application/json + openAPIDocKey: '200' + listPerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patchPerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + recreateInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize + response: + mediaType: application/json + openAPIDocKey: '200' + setInstanceTemplate: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTargetPools: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updatePerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionInstanceGroupManagers + title: regionInstanceGroupManagers + regionInstanceGroups: + id: google.compute.regionInstanceGroups + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroups/{instanceGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setNamedPorts: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionInstanceGroups + title: regionInstanceGroups + regionInstances: + id: google.compute.regionInstances + methods: + bulkInsert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instances/bulkInsert + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionInstances + title: regionInstances + regionNetworkEndpointGroups: + id: google.compute.regionNetworkEndpointGroups + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/networkEndpointGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/networkEndpointGroups + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionNetworkEndpointGroups + title: regionNetworkEndpointGroups + regionNotificationEndpoints: + id: google.compute.regionNotificationEndpoints + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/notificationEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/notificationEndpoints + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionNotificationEndpoints + title: regionNotificationEndpoints + regionOperations: + id: google.compute.regionOperations + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/operations/{operation} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/operations/{operation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/operations + response: + mediaType: application/json + openAPIDocKey: '200' + wait: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/operations/{operation}/wait + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionOperations + title: regionOperations + regionSslCertificates: + id: google.compute.regionSslCertificates + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/sslCertificates/{sslCertificate} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/sslCertificates/{sslCertificate} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/sslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/sslCertificates + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionSslCertificates + title: regionSslCertificates + regionTargetHttpProxies: + id: google.compute.regionTargetHttpProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies + response: + mediaType: application/json + openAPIDocKey: '200' + setUrlMap: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionTargetHttpProxies + title: regionTargetHttpProxies + regionTargetHttpsProxies: + id: google.compute.regionTargetHttpsProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies + response: + mediaType: application/json + openAPIDocKey: '200' + setSslCertificates: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setUrlMap: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionTargetHttpsProxies + title: regionTargetHttpsProxies + regionUrlMaps: + id: google.compute.regionUrlMaps + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/urlMaps + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/urlMaps + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + validate: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap}/validate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionUrlMaps + title: regionUrlMaps + regions: + id: google.compute.regions + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions + response: + mediaType: application/json + openAPIDocKey: '200' + name: regions + title: regions + reservations: + id: google.compute.reservations + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/reservations + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/reservations/{reservation} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/reservations/{reservation} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/reservations + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/reservations + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/reservations/{reservation}/resize + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: reservations + title: reservations + resourcePolicies: + id: google.compute.resourcePolicies + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/resourcePolicies + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: resourcePolicies + title: resourcePolicies + routers: + id: google.compute.routers + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/routers + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/routers/{router} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/routers/{router} + response: + mediaType: application/json + openAPIDocKey: '200' + getNatMappingInfo: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo + response: + mediaType: application/json + openAPIDocKey: '200' + getRouterStatus: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/routers/{router}/getRouterStatus + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/routers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/routers + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/routers/{router} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + preview: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/routers/{router}/preview + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/routers/{router} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: routers + title: routers + routes: + id: google.compute.routes + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/routes/{route} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/routes/{route} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/routes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/routes + response: + mediaType: application/json + openAPIDocKey: '200' + name: routes + title: routes + securityPolicies: + id: google.compute.securityPolicies + methods: + addRule: + operation: + $ref: post + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy}/addRule + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + getRule: + operation: + $ref: get + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy}/getRule + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/securityPolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/securityPolicies + response: + mediaType: application/json + openAPIDocKey: '200' + listPreconfiguredExpressionSets: + operation: + $ref: get + path: + $ref: /projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patchRule: + operation: + $ref: post + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy}/patchRule + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removeRule: + operation: + $ref: post + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy}/removeRule + response: + mediaType: application/json + openAPIDocKey: '200' + name: securityPolicies + title: securityPolicies + serviceAttachments: + id: google.compute.serviceAttachments + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/serviceAttachments + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: serviceAttachments + title: serviceAttachments + snapshots: + id: google.compute.snapshots + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/snapshots/{snapshot} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/snapshots/{snapshot} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/global/snapshots/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/snapshots + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/snapshots/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/global/snapshots/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/snapshots/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: snapshots + title: snapshots + sslCertificates: + id: google.compute.sslCertificates + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/sslCertificates + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/sslCertificates/{sslCertificate} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslCertificates/{sslCertificate} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/sslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslCertificates + response: + mediaType: application/json + openAPIDocKey: '200' + name: sslCertificates + title: sslCertificates + sslPolicies: + id: google.compute.sslPolicies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/sslPolicies/{sslPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslPolicies/{sslPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/sslPolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslPolicies + response: + mediaType: application/json + openAPIDocKey: '200' + listAvailableFeatures: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslPolicies/listAvailableFeatures + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/sslPolicies/{sslPolicy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: sslPolicies + title: sslPolicies + subnetworks: + id: google.compute.subnetworks + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/subnetworks + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork} + response: + mediaType: application/json + openAPIDocKey: '200' + expandIpCidrRange: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/subnetworks + response: + mediaType: application/json + openAPIDocKey: '200' + listUsable: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/subnetworks/listUsable + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setPrivateIpGoogleAccess: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: subnetworks + title: subnetworks + targetGrpcProxies: + id: google.compute.targetGrpcProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetGrpcProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetGrpcProxies + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetGrpcProxies + title: targetGrpcProxies + targetHttpProxies: + id: google.compute.targetHttpProxies + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetHttpProxies + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetHttpProxies/{targetHttpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetHttpProxies/{targetHttpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetHttpProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetHttpProxies + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/targetHttpProxies/{targetHttpProxy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setUrlMap: + operation: + $ref: post + path: + $ref: /projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetHttpProxies + title: targetHttpProxies + targetHttpsProxies: + id: google.compute.targetHttpsProxies + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetHttpsProxies + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetHttpsProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetHttpsProxies + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setQuicOverride: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSslCertificates: + operation: + $ref: post + path: + $ref: /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSslPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setUrlMap: + operation: + $ref: post + path: + $ref: /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetHttpsProxies + title: targetHttpsProxies + targetInstances: + id: google.compute.targetInstances + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetInstances + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/targetInstances/{targetInstance} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/targetInstances/{targetInstance} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/targetInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/targetInstances + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetInstances + title: targetInstances + targetPools: + id: google.compute.targetPools + methods: + addHealthCheck: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + addInstance: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetPools + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool} + response: + mediaType: application/json + openAPIDocKey: '200' + getHealth: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetPools + response: + mediaType: application/json + openAPIDocKey: '200' + removeHealthCheck: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removeInstance: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setBackup: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetPools + title: targetPools + targetSslProxies: + id: google.compute.targetSslProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetSslProxies + response: + mediaType: application/json + openAPIDocKey: '200' + setBackendService: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setProxyHeader: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSslCertificates: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSslPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetSslProxies + title: targetSslProxies + targetTcpProxies: + id: google.compute.targetTcpProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetTcpProxies/{targetTcpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetTcpProxies/{targetTcpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetTcpProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetTcpProxies + response: + mediaType: application/json + openAPIDocKey: '200' + setBackendService: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setProxyHeader: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetTcpProxies + title: targetTcpProxies + targetVpnGateways: + id: google.compute.targetVpnGateways + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetVpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetVpnGateways + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetVpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetVpnGateways + title: targetVpnGateways + urlMaps: + id: google.compute.urlMaps + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/urlMaps + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/urlMaps/{urlMap} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/urlMaps/{urlMap} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/urlMaps + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + invalidateCache: + operation: + $ref: post + path: + $ref: /projects/{project}/global/urlMaps/{urlMap}/invalidateCache + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/urlMaps + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/urlMaps/{urlMap} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/urlMaps/{urlMap} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + validate: + operation: + $ref: post + path: + $ref: /projects/{project}/global/urlMaps/{urlMap}/validate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: urlMaps + title: urlMaps + vpnGateways: + id: google.compute.vpnGateways + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/vpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{vpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{vpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + getStatus: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/vpnGateways + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: vpnGateways + title: vpnGateways + vpnTunnels: + id: google.compute.vpnTunnels + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/vpnTunnels + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/vpnTunnels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnTunnels + response: + mediaType: application/json + openAPIDocKey: '200' + name: vpnTunnels + title: vpnTunnels + zoneOperations: + id: google.compute.zoneOperations + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/operations/{operation} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/operations/{operation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/operations + response: + mediaType: application/json + openAPIDocKey: '200' + wait: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/operations/{operation}/wait + response: + mediaType: application/json + openAPIDocKey: '200' + name: zoneOperations + title: zoneOperations + zones: + id: google.compute.zones + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones + response: + mediaType: application/json + openAPIDocKey: '200' + name: zones + title: zones diff --git a/test/registry/src/googleapis.com/v1/resources/compute-v1.yaml.sig b/test/registry/src/googleapis.com/v1/resources/compute-v1.yaml.sig new file mode 100644 index 00000000..961547ea --- /dev/null +++ b/test/registry/src/googleapis.com/v1/resources/compute-v1.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELaD27KWAKUE2vPawk92hxAkwyrDj0vSWMtneu5A5hI9RdQE4Ao2AeI4jmn/7nttRIZti2GDkGF6DPAIRJHl9TU7nbRFi2MCA== \ No newline at end of file diff --git a/test/registry/src/googleapis.com/v1/services-split/compute/compute-disks-v1.yaml b/test/registry/src/googleapis.com/v1/services-split/compute/compute-disks-v1.yaml new file mode 100644 index 00000000..7393edfb --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services-split/compute/compute-disks-v1.yaml @@ -0,0 +1,28106 @@ +components: + parameters: + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + enum: + - '1' + - '2' + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + enum: + - json + - media + - proto + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: API key. Your API key identifies your project and provides you + with API access, quota, and reports. Required unless you provide an OAuth + 2.0 token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: Available to use for quota purposes for server-side applications. + Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + in: query + name: quotaUser + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + userIp: + description: Legacy name for parameter that has been superseded by `quotaUser`. + in: query + name: userIp + schema: + type: string + schemas: + AcceleratorConfig: + description: A specification of the type and number of accelerator cards attached + to the instance. + properties: + acceleratorCount: + description: The number of the guest accelerator cards exposed to this instance. + format: int32 + type: integer + acceleratorType: + description: 'Full or partial URL of the accelerator type resource to attach + to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 + If you are creating an instance template, specify only the accelerator + name. See GPUs on Compute Engine for a full list of accelerator types.' + type: string + type: object + AcceleratorType: + description: Represents an Accelerator Type resource. Google Cloud Platform + provides graphics processing units (accelerators) that you can add to VM instances + to improve or accelerate performance when working with intensive workloads. + For more information, read GPUs on Compute Engine. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + accelerator type.' + description: + description: '[Output Only] An optional textual description of the resource.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#acceleratorType + description: '[Output Only] The type of the resource. Always compute#acceleratorType + for accelerator types.' + type: string + maximumCardsPerInstance: + description: '[Output Only] Maximum number of accelerator cards allowed + per instance.' + format: int32 + type: integer + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + selfLink: + description: '[Output Only] Server-defined, fully qualified URL for this + resource.' + type: string + zone: + description: '[Output Only] The name of the zone where the accelerator type + resides, such as us-central1-a. You must specify this field as part of + the HTTP request URL. It is not settable as a field in the request body.' + type: string + type: object + AcceleratorTypeAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/AcceleratorTypesScopedList' + description: '[Output Only] Name of the scope containing this set of accelerator + types.' + description: A list of AcceleratorTypesScopedList resources. + type: object + kind: + default: compute#acceleratorTypeAggregatedList + description: '[Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList + for aggregated lists of accelerator types.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AcceleratorTypeList: + description: Contains a list of accelerator types. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of AcceleratorType resources. + items: + $ref: '#/components/schemas/AcceleratorType' + type: array + kind: + default: compute#acceleratorTypeList + description: '[Output Only] Type of resource. Always compute#acceleratorTypeList + for lists of accelerator types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AcceleratorTypesScopedList: + properties: + acceleratorTypes: + description: '[Output Only] A list of accelerator types contained in this + scope.' + items: + $ref: '#/components/schemas/AcceleratorType' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + accelerator types 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AccessConfig: + description: An access configuration attached to an instance's network interface. + Only one access config per instance is supported. + properties: + externalIpv6: + description: '[Output Only] The first IPv6 address of the external IPv6 + range associated with this instance, prefix length is stored in externalIpv6PrefixLength + in ipv6AccessConfig. The field is output only, an IPv6 address from a + subnetwork associated with the instance will be allocated dynamically.' + type: string + externalIpv6PrefixLength: + description: '[Output Only] The prefix length of the external IPv6 range.' + format: int32 + type: integer + kind: + default: compute#accessConfig + description: '[Output Only] Type of the resource. Always compute#accessConfig + for access configs.' + type: string + name: + description: The name of this access configuration. The default and recommended + name is External NAT, but you can use any arbitrary string, such as My + external IP or Network Access. + type: string + natIP: + description: An external IP address associated with this instance. Specify + an unused static external IP address available to the project or leave + this field undefined to use an IP from a shared ephemeral IP address pool. + If you specify a static external IP address, it must live in the same + region as the zone of the instance. + type: string + networkTier: + description: 'This signifies the networking tier used for configuring this + access configuration and can only take the following values: PREMIUM, + STANDARD. If an AccessConfig is specified without a valid external IP + address, an ephemeral IP will be created with this networkTier. If an + AccessConfig with a valid external IP address is specified, it must match + that of the networkTier associated with the Address resource owning that + IP.' + enum: + - PREMIUM + - STANDARD + type: string + publicPtrDomainName: + description: The DNS domain name for the public PTR record. You can set + this field only if the `setPublicPtr` field is enabled in accessConfig. + If this field is unspecified in ipv6AccessConfig, a default PTR record + will be createc for first IP in associated external IPv6 range. + type: string + setPublicPtr: + description: Specifies whether a public DNS 'PTR' record should be created + to map the external IP address of the instance to a DNS domain name. This + field is not used in ipv6AccessConfig. A default PTR record will be created + if the VM has external IPv6 range associated. + type: boolean + type: + default: ONE_TO_ONE_NAT + description: The type of configuration. The default and only option is ONE_TO_ONE_NAT. + enum: + - DIRECT_IPV6 + - ONE_TO_ONE_NAT + type: string + type: object + Address: + description: 'Represents an IP Address resource. Google Compute Engine has two + IP Address resources: * [Global (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses) + * [Regional (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/addresses) + For more information, see Reserving a static external IP address.' + properties: + address: + description: The static IP address represented by this resource. + type: string + addressType: + description: The type of address to reserve, either INTERNAL or EXTERNAL. + If unspecified, defaults to EXTERNAL. + enum: + - EXTERNAL + - INTERNAL + - UNSPECIFIED_TYPE + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this field + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + ipVersion: + description: The IP version that will be used by this address. Valid options + are IPV4 or IPV6. This can only be specified for a global address. + enum: + - IPV4 + - IPV6 + - UNSPECIFIED_VERSION + type: string + kind: + default: compute#address + description: '[Output Only] Type of the resource. Always compute#address + for addresses.' + type: string + name: + description: 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])?`. The first character must be a + lowercase letter, and all following characters (except for the last character) + must be a dash, lowercase letter, or digit. The last character must be + a lowercase letter or digit. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: The URL of the network in which to reserve the address. This + field can only be used with INTERNAL type with the VPC_PEERING purpose. + type: string + networkTier: + description: 'This signifies the networking tier used for configuring this + address and can only take the following values: PREMIUM or STANDARD. Internal + IP addresses are always Premium Tier; global external IP addresses are + always Premium Tier; regional external IP addresses can be either Standard + or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.' + enum: + - PREMIUM + - STANDARD + type: string + prefixLength: + description: The prefix length if the resource represents an IP range. + format: int32 + type: integer + purpose: + description: 'The purpose of this resource, which can be one of the following + values: - GCE_ENDPOINT for addresses that are used by VM instances, alias + IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a + DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder + IP addresses (regional internal IP address in a subnet of a VPC network) + - VPC_PEERING for global internal IP addresses used for private services + access allocated ranges. - NAT_AUTO for the regional external IP addresses + used by Cloud NAT when allocating addresses using . - IPSEC_INTERCONNECT + for addresses created from a private IP range that are reserved for a + VLAN attachment in an *IPsec-encrypted Cloud Interconnect* configuration. + These addresses are regional resources. Not currently available publicly. + - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned + to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for + a private network address that is used to configure Private Service Connect. + Only global internal addresses can use this purpose. ' + enum: + - DNS_RESOLVER + - GCE_ENDPOINT + - IPSEC_INTERCONNECT + - NAT_AUTO + - PRIVATE_SERVICE_CONNECT + - SHARED_LOADBALANCER_VIP + - VPC_PEERING + type: string + region: + description: '[Output Only] The URL of the region where a regional address + resides. For regional addresses, you must specify the region as a path + parameter in the HTTP request URL. *This field is not applicable to global + addresses.*' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of the address, which can be one + of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently + in the process of being reserved. A RESERVED address is currently reserved + and available to use. An IN_USE address is currently being used by another + resource and is not available.' + enum: + - IN_USE + - RESERVED + - RESERVING + type: string + subnetwork: + description: The URL of the subnetwork in which to reserve the address. + If an IP address is specified, it must be within the subnetwork's IP range. + This field can only be used with INTERNAL type with a GCE_ENDPOINT or + DNS_RESOLVER purpose. + type: string + users: + description: '[Output Only] The URLs of the resources that are using this + address.' + items: + type: string + type: array + type: object + AddressAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/AddressesScopedList' + description: '[Output Only] Name of the scope containing this set of addresses.' + description: A list of AddressesScopedList resources. + type: object + kind: + default: compute#addressAggregatedList + description: '[Output Only] Type of resource. Always compute#addressAggregatedList + for aggregated lists of addresses.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AddressList: + description: Contains a list of addresses. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Address resources. + items: + $ref: '#/components/schemas/Address' + type: array + kind: + default: compute#addressList + description: '[Output Only] Type of resource. Always compute#addressList + for lists of addresses.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AddressesScopedList: + properties: + addresses: + description: '[Output Only] A list of addresses contained in this scope.' + items: + $ref: '#/components/schemas/Address' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of addresses 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AdvancedMachineFeatures: + description: Specifies options for controlling advanced machine features. Options + that would traditionally be configured in a BIOS belong here. Features that + require operating system support may have corresponding entries in the GuestOsFeatures + of an Image (e.g., whether or not the OS in the Image supports nested virtualization + being enabled or disabled). + properties: + enableNestedVirtualization: + description: Whether to enable nested virtualization or not (default is + false). + type: boolean + threadsPerCore: + description: The number of threads per physical core. To disable simultaneous + multithreading (SMT) set this to 1. If unset, the maximum number of threads + supported per core by the underlying processor is assumed. + format: int32 + type: integer + type: object + AliasIpRange: + description: An alias IP range attached to an instance's network interface. + properties: + ipCidrRange: + description: The IP alias ranges to allocate for this interface. This IP + CIDR range must belong to the specified subnetwork and cannot contain + IP addresses reserved by system or used by other network interfaces. This + range may be a single IP address (such as 10.2.3.4), a netmask (such as + /24) or a CIDR-formatted string (such as 10.1.2.0/24). + type: string + subnetworkRangeName: + description: The name of a subnetwork secondary IP range from which to allocate + an IP alias range. If not specified, the primary range of the subnetwork + is used. + type: string + type: object + AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk: + properties: + diskSizeGb: + description: Specifies the size of the disk in base-2 GB. + format: int64 + type: string + interface: + description: Specifies the disk interface to use for attaching this disk, + which is either SCSI or NVME. The default is SCSI. For performance characteristics + of SCSI over NVMe, see Local SSD performance. + enum: + - NVME + - SCSI + type: string + type: object + AllocationSpecificSKUAllocationReservedInstanceProperties: + description: 'Properties of the SKU instances being reserved. Next ID: 9' + properties: + guestAccelerators: + description: Specifies accelerator type and count. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + localSsds: + description: Specifies amount of local ssd to reserve with each instance. + The type of disk is local-ssd. + items: + $ref: '#/components/schemas/AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk' + type: array + locationHint: + description: An opaque location hint used to place the allocation close + to other resources. This field is for use by internal tools that use the + public API. + type: string + machineType: + description: Specifies type of machine (name only) which has fixed number + of vCPUs and fixed amount of memory. This also includes specifying custom + machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. + type: string + minCpuPlatform: + description: Minimum cpu platform the reservation. + type: string + type: object + AllocationSpecificSKUReservation: + description: 'This reservation type allows to pre allocate specific instance + configuration. Next ID: 5' + properties: + count: + description: Specifies the number of resources that are allocated. + format: int64 + type: string + inUseCount: + description: '[Output Only] Indicates how many instances are in use.' + format: int64 + type: string + instanceProperties: + $ref: '#/components/schemas/AllocationSpecificSKUAllocationReservedInstanceProperties' + description: The instance properties for the reservation. + type: object + AttachedDisk: + description: An instance-attached disk resource. + properties: + autoDelete: + description: Specifies whether the disk will be auto-deleted when the instance + is deleted (but not when the disk is detached from the instance). + type: boolean + boot: + description: Indicates that this is a boot disk. The virtual machine will + use the first partition of the disk for its root filesystem. + type: boolean + deviceName: + description: Specifies a unique device name of your choice that is reflected + into the /dev/disk/by-id/google-* tree of a Linux operating system running + within the instance. This name can be used to reference the device for + mounting, resizing, and so on, from within the instance. If not specified, + the server chooses a default device name to apply to this disk, in the + form persistent-disk-x, where x is a number assigned by Google Compute + Engine. This field is only applicable for persistent disks. + type: string + diskEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: Encrypts or decrypts a disk using a customer-supplied encryption + key. If you are creating a new disk, this field encrypts the new disk + using an encryption key that you provide. If you are attaching an existing + disk that is already encrypted, this field decrypts the disk using the + customer-supplied encryption key. If you encrypt a disk using a customer-supplied + key, you must provide the same key again when you attempt to use this + resource at a later time. For example, you must provide the key when you + create a snapshot or an image from the disk or when you attach the disk + to a virtual machine instance. If you do not provide an encryption key, + then the disk will be encrypted using an automatically generated key and + you do not need to provide a key to use the disk later. Instance templates + do not store customer-supplied encryption keys, so you cannot use your + own keys to encrypt disks in a managed instance group. + diskSizeGb: + description: The size of the disk in GB. + format: int64 + type: string + 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. + items: + $ref: '#/components/schemas/GuestOsFeature' + type: array + index: + description: '[Output Only] A zero-based index to this disk, where 0 is + reserved for the boot disk. If you have many disks attached to an instance, + each disk would have a unique index number.' + format: int32 + type: integer + initializeParams: + $ref: '#/components/schemas/AttachedDiskInitializeParams' + description: '[Input Only] Specifies the parameters for a new disk that + will be created alongside the new instance. Use initialization parameters + to create boot disks or local SSDs attached to the new instance. This + property is mutually exclusive with the source property; you can only + define one or the other, but not both.' + interface: + description: Specifies the disk interface to use for attaching this disk, + which is either SCSI or NVME. The default is SCSI. Persistent disks must + always use SCSI and the request will fail if you attempt to attach a persistent + disk in any other format than SCSI. Local SSDs can use either NVME or + SCSI. For performance characteristics of SCSI over NVMe, see Local SSD + performance. + enum: + - NVME + - SCSI + type: string + kind: + default: compute#attachedDisk + description: '[Output Only] Type of the resource. Always compute#attachedDisk + for attached disks.' + type: string + licenses: + description: '[Output Only] Any valid publicly visible licenses.' + items: + type: string + type: array + mode: + description: The mode in which to attach this disk, either READ_WRITE or + READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE + mode. + enum: + - READ_ONLY + - READ_WRITE + type: string + shieldedInstanceInitialState: + $ref: '#/components/schemas/InitialStateConfig' + description: '[Output Only] shielded vm initial state stored on disk' + source: + description: Specifies a valid partial or full URL to an existing Persistent + Disk resource. When creating a new instance, one of initializeParams.sourceImage + or initializeParams.sourceSnapshot or disks.source is required except + for local SSD. If desired, you can also attach existing non-root persistent + disks using this property. This field is only applicable for persistent + disks. Note that for InstanceTemplate, specify the disk name, not the + URL for the disk. + type: string + type: + description: Specifies the type of the disk, either SCRATCH or PERSISTENT. + If not specified, the default is PERSISTENT. + enum: + - PERSISTENT + - SCRATCH + type: string + type: object + AttachedDiskInitializeParams: + description: '[Input Only] Specifies the parameters for a new disk that will + be created alongside the new instance. Use initialization parameters to create + boot disks or local SSDs attached to the new instance. This property is mutually + exclusive with the source property; you can only define one or the other, + but not both.' + properties: + description: + description: An optional description. Provide this property when creating + the disk. + type: string + diskName: + description: 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. + type: string + diskSizeGb: + description: 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. + format: int64 + type: string + diskType: + 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 define this field, you can provide either the full + or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - + zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is + the name of the disk type, not URL.' + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this disk. These can be later modified by + the disks.setLabels method. This field is only applicable for persistent + disks. + type: object + onUpdateAction: + description: Specifies which action to take on instance update with this + disk. Default is to use the existing disk. + enum: + - RECREATE_DISK + - RECREATE_DISK_IF_SOURCE_CHANGED + - USE_EXISTING_DISK + type: string + provisionedIops: + description: Indicates how many IOPS to provision for the disk. This sets + the number of I/O operations per second that the disk can handle. Values + must be between 10,000 and 120,000. For more details, see the Extreme + persistent disk documentation. + format: int64 + type: string + resourcePolicies: + description: Resource policies applied to this disk for automatic snapshot + creations. Specified using the full or partial URL. For instance template, + specify only the resource policy name. + items: + type: string + type: array + sourceImage: + description: 'The source image to create this disk. When creating a new + instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot + or disks.source is required except for local SSD. To create a disk with + one of the public operating system images, specify the image by its family + name. For example, specify family/debian-9 to use the latest Debian 9 + image: projects/debian-cloud/global/images/family/debian-9 Alternatively, + use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD + To create a disk with a custom image that you created, specify the image + name in the following format: global/images/my-custom-image You can also + specify a custom image by its image family, which returns the latest version + of the image in that family. Replace the image name with family/family-name: + global/images/family/my-image-family If the source image is deleted later, + this field will not be set.' + type: string + sourceImageEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption key. + Instance templates do not store customer-supplied encryption keys, so + you cannot create disks for instances in a managed instance group if the + source images are encrypted with your own keys. + sourceSnapshot: + description: 'The source snapshot to create this disk. When creating a new + instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage + or disks.source is required except for local SSD. To create a disk with + a snapshot that you created, specify the snapshot name in the following + format: global/snapshots/my-backup If the source snapshot is deleted later, + this field will not be set.' + type: string + sourceSnapshotEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source snapshot. + type: object + AuditConfig: + description: 'Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if any, + are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. + If there are AuditConfigs for both `allServices` and a specific service, the + union of the two AuditConfigs is used for that service: the log_types specified + in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig + are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": + [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" + }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", + "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", + "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, + this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also + exempts jose@example.com from DATA_READ logging, and aliya@example.com from + DATA_WRITE logging.' + properties: + auditLogConfigs: + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/AuditLogConfig' + type: array + exemptedMembers: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + service: + description: Specifies a service that will be enabled for audit logging. + For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` + is a special value that covers all services. + type: string + type: object + AuditLogConfig: + description: 'Provides the configuration for logging a type of permissions. + Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": + [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables + ''DATA_READ'' and ''DATA_WRITE'' logging, while exempting jose@example.com + from DATA_READ logging.' + properties: + exemptedMembers: + description: Specifies the identities that do not cause logging for this + type of permission. Follows the same format of Binding.members. + items: + type: string + type: array + ignoreChildExemptions: + description: This is deprecated and has no effect. Do not use. + type: boolean + logType: + description: The log type that this config enables. + enum: + - ADMIN_READ + - DATA_READ + - DATA_WRITE + - LOG_TYPE_UNSPECIFIED + type: string + type: object + AuthorizationLoggingOptions: + description: This is deprecated and has no effect. Do not use. + properties: + permissionType: + description: This is deprecated and has no effect. Do not use. + enum: + - ADMIN_READ + - ADMIN_WRITE + - DATA_READ + - DATA_WRITE + - PERMISSION_TYPE_UNSPECIFIED + type: string + type: object + Autoscaler: + description: 'Represents an Autoscaler resource. Google Compute Engine has two + Autoscaler resources: * [Zonal](/compute/docs/reference/rest/v1/autoscalers) + * [Regional](/compute/docs/reference/rest/v1/regionAutoscalers) Use autoscalers + to automatically add or delete instances from a managed instance group according + to your defined autoscaling policy. For more information, read Autoscaling + Groups of Instances. For zonal managed instance groups resource, use the autoscaler + resource. For regional managed instance groups, use the regionAutoscalers + resource.' + properties: + autoscalingPolicy: + $ref: '#/components/schemas/AutoscalingPolicy' + description: 'The configuration parameters for the autoscaling algorithm. + You can define one or more signals for an autoscaler: cpuUtilization, + customMetricUtilizations, and loadBalancingUtilization. If none of these + are specified, the default will be to autoscale based on cpuUtilization + to 0.6 or 60%.' + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#autoscaler + description: '[Output Only] Type of the resource. Always compute#autoscaler + for autoscalers.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + recommendedSize: + description: '[Output Only] Target recommended MIG size (number of instances) + computed by autoscaler. Autoscaler calculates the recommended MIG size + even when the autoscaling policy mode is different from ON. This field + is empty when autoscaler is not connected to an existing managed instance + group or autoscaler did not generate its prediction.' + format: int32 + type: integer + region: + description: '[Output Only] URL of the region where the instance group resides + (for autoscalers living in regional scope).' + type: string + scalingScheduleStatus: + additionalProperties: + $ref: '#/components/schemas/ScalingScheduleStatus' + description: '[Output Only] Status information of existing scaling schedules.' + type: object + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of the autoscaler configuration. + Current set of possible values: - PENDING: Autoscaler backend hasn''t + read new/updated configuration. - DELETING: Configuration is being deleted. + - ACTIVE: Configuration is acknowledged to be effective. Some warnings + might be present in the statusDetails field. - ERROR: Configuration has + errors. Actionable for users. Details are present in the statusDetails + field. New values might be added in the future.' + enum: + - ACTIVE + - DELETING + - ERROR + - PENDING + type: string + statusDetails: + description: '[Output Only] Human-readable details about the current state + of the autoscaler. Read the documentation for Commonly returned status + messages for examples of status messages you might encounter.' + items: + $ref: '#/components/schemas/AutoscalerStatusDetails' + type: array + target: + description: URL of the managed instance group that this autoscaler will + scale. This field is required when creating an autoscaler. + type: string + zone: + description: '[Output Only] URL of the zone where the instance group resides + (for autoscalers living in zonal scope).' + type: string + type: object + AutoscalerAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/AutoscalersScopedList' + description: '[Output Only] Name of the scope containing this set of autoscalers.' + description: A list of AutoscalersScopedList resources. + type: object + kind: + default: compute#autoscalerAggregatedList + description: '[Output Only] Type of resource. Always compute#autoscalerAggregatedList + for aggregated lists of autoscalers.' + 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 + unreachables: + description: '[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AutoscalerList: + description: Contains a list of Autoscaler resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Autoscaler resources. + items: + $ref: '#/components/schemas/Autoscaler' + type: array + kind: + default: compute#autoscalerList + description: '[Output Only] Type of resource. Always compute#autoscalerList + for lists of autoscalers.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AutoscalerStatusDetails: + properties: + message: + description: The status message. + type: string + type: + description: 'The type of error, warning, or notice returned. Current set + of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances + in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST + (ERROR): There is no backend service attached to the instance group. - + CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater + than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): + The custom metric samples are not exported often enough to be a credible + base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric + that was specified does not exist or does not have the necessary labels. + - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. + This means the autoscaler cannot add or remove instances from the instance + group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did + not receive any data from the custom metric configured for autoscaling. + - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured + to scale based on a load balancing signal but the instance group has not + received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling + is turned off. The number of instances in the group won''t change automatically. + The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): + Autoscaling is in the "Autoscale only out" mode. The autoscaler can add + instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): + The instance group cannot be autoscaled because it has more than one backend + service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is + insufficient quota for the necessary resources, such as CPU or number + of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional + autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST + (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION + (ERROR): Autoscaling does not work with an HTTP/S load balancer that has + been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal + autoscalers: there is a resource stockout in the chosen zone. For regional + autoscalers: in at least one of the zones you''re using there is a resource + stockout. New values might be added in the future. Some of the values + might not be available in all API versions.' + enum: + - ALL_INSTANCES_UNHEALTHY + - BACKEND_SERVICE_DOES_NOT_EXIST + - CAPPED_AT_MAX_NUM_REPLICAS + - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE + - CUSTOM_METRIC_INVALID + - MIN_EQUALS_MAX + - MISSING_CUSTOM_METRIC_DATA_POINTS + - MISSING_LOAD_BALANCING_DATA_POINTS + - MODE_OFF + - MODE_ONLY_SCALE_OUT + - MODE_ONLY_UP + - MORE_THAN_ONE_BACKEND_SERVICE + - NOT_ENOUGH_QUOTA_AVAILABLE + - REGION_RESOURCE_STOCKOUT + - SCALING_TARGET_DOES_NOT_EXIST + - SCHEDULED_INSTANCES_GREATER_THAN_AUTOSCALER_MAX + - SCHEDULED_INSTANCES_LESS_THAN_AUTOSCALER_MIN + - UNKNOWN + - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION + - ZONE_RESOURCE_STOCKOUT + type: string + type: object + AutoscalersScopedList: + properties: + autoscalers: + description: '[Output Only] A list of autoscalers contained in this scope.' + items: + $ref: '#/components/schemas/Autoscaler' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of autoscalers 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AutoscalingPolicy: + description: Cloud Autoscaler policy. + properties: + coolDownPeriodSec: + description: The number of seconds that the autoscaler waits before it starts + collecting information from a new instance. This prevents the autoscaler + from collecting information when the instance is initializing, during + which the collected usage would not be reliable. The default time autoscaler + waits is 60 seconds. Virtual machine initialization times might vary because + of numerous factors. We recommend that you test how long an instance may + take to initialize. To do this, create an instance and time the startup + process. + format: int32 + type: integer + cpuUtilization: + $ref: '#/components/schemas/AutoscalingPolicyCpuUtilization' + description: Defines the CPU utilization policy that allows the autoscaler + to scale based on the average CPU utilization of a managed instance group. + customMetricUtilizations: + description: Configuration parameters of autoscaling based on a custom metric. + items: + $ref: '#/components/schemas/AutoscalingPolicyCustomMetricUtilization' + type: array + loadBalancingUtilization: + $ref: '#/components/schemas/AutoscalingPolicyLoadBalancingUtilization' + description: Configuration parameters of autoscaling based on load balancer. + maxNumReplicas: + description: The maximum number of instances that the autoscaler can scale + out to. This is required when creating or updating an autoscaler. The + maximum number of replicas must not be lower than minimal number of replicas. + format: int32 + type: integer + minNumReplicas: + description: The minimum number of replicas that the autoscaler can scale + in to. This cannot be less than 0. If not provided, autoscaler chooses + a default value depending on maximum number of instances allowed. + format: int32 + type: integer + mode: + description: Defines operating mode for this policy. + enum: + - false + - true + - ONLY_SCALE_OUT + - ONLY_UP + type: string + scaleInControl: + $ref: '#/components/schemas/AutoscalingPolicyScaleInControl' + scalingSchedules: + additionalProperties: + $ref: '#/components/schemas/AutoscalingPolicyScalingSchedule' + description: Scaling schedules defined for an autoscaler. Multiple schedules + can be set on an autoscaler, and they can overlap. During overlapping + periods the greatest min_required_replicas of all scaling schedules is + applied. Up to 128 scaling schedules are allowed. + type: object + type: object + AutoscalingPolicyCpuUtilization: + description: CPU utilization policy. + properties: + predictiveMethod: + description: 'Indicates whether predictive autoscaling based on CPU metric + is enabled. Valid values are: * NONE (default). No predictive method is + used. The autoscaler scales the group to meet current demand based on + real-time metrics. * OPTIMIZE_AVAILABILITY. Predictive autoscaling improves + availability by monitoring daily and weekly load patterns and scaling + out ahead of anticipated demand.' + enum: + - NONE + - OPTIMIZE_AVAILABILITY + type: string + utilizationTarget: + description: The target CPU utilization that the autoscaler maintains. Must + be a float value in the range (0, 1]. If not specified, the default is + 0.6. If the CPU level is below the target utilization, the autoscaler + scales in the number of instances until it reaches the minimum number + of instances you specified or until the average CPU of your instances + reaches the target utilization. If the average CPU is above the target + utilization, the autoscaler scales out until it reaches the maximum number + of instances you specified or until the average utilization reaches the + target utilization. + format: double + type: number + type: object + AutoscalingPolicyCustomMetricUtilization: + description: Custom utilization metric policy. + properties: + filter: + description: 'A filter string, compatible with a Stackdriver Monitoring + filter string for TimeSeries.list API call. This filter is used to select + a specific TimeSeries for the purpose of autoscaling and to determine + whether the metric is exporting per-instance or per-group data. For the + filter to be valid for autoscaling purposes, the following rules apply: + - You can only use the AND operator for joining selectors. - You can only + use direct equality comparison operator (=) without any functions for + each selector. - You can specify the metric in both the filter string + and in the metric field. However, if specified in both places, the metric + must be identical. - The monitored resource type determines what kind + of values are expected for the metric. If it is a gce_instance, the autoscaler + expects the metric to include a separate TimeSeries for each instance + in a group. In such a case, you cannot filter on resource labels. If the + resource type is any other value, the autoscaler expects this metric to + contain values that apply to the entire autoscaled instance group and + resource label filtering can be performed to point autoscaler at the correct + TimeSeries to scale upon. This is called a *per-group metric* for the + purpose of autoscaling. If not specified, the type defaults to gce_instance. + Try to provide a filter that is selective enough to pick just one TimeSeries + for the autoscaled group or for each of the instances (if you are using + gce_instance resource type). If multiple TimeSeries are returned upon + the query execution, the autoscaler will sum their respective values to + obtain its scaling value.' + type: string + metric: + description: The identifier (type) of the Stackdriver Monitoring metric. + The metric cannot have negative values. The metric must have a value type + of INT64 or DOUBLE. + type: string + singleInstanceAssignment: + description: If scaling is based on a per-group metric value that represents + the total amount of work to be done or resource usage, set this value + to an amount assigned for a single instance of the scaled group. Autoscaler + keeps the number of instances proportional to the value of this metric. + The metric itself does not change value due to group resizing. A good + metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages + or a custom metric exporting the total number of requests coming to your + instances. A bad example would be a metric exporting an average or median + latency, since this value can't include a chunk assignable to a single + instance, it could be better used with utilization_target instead. + format: double + type: number + utilizationTarget: + description: The target value of the metric that autoscaler maintains. This + must be a positive value. A utilization metric scales number of virtual + machines handling requests to increase or decrease proportionally to the + metric. For example, a good metric to use as a utilization_target is https://www.googleapis.com/compute/v1/instance/network/received_bytes_count. + The autoscaler works to keep this value constant for each of the instances. + format: double + type: number + utilizationTargetType: + description: Defines how target utilization value is expressed for a Stackdriver + Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + enum: + - DELTA_PER_MINUTE + - DELTA_PER_SECOND + - GAUGE + type: string + type: object + AutoscalingPolicyLoadBalancingUtilization: + description: Configuration parameters of autoscaling based on load balancing. + properties: + utilizationTarget: + description: Fraction of backend capacity utilization (set in HTTP(S) load + balancing configuration) that the autoscaler maintains. Must be a positive + float value. If not defined, the default is 0.8. + format: double + type: number + type: object + AutoscalingPolicyScaleInControl: + description: Configuration that allows for slower scale in so that even if Autoscaler + recommends an abrupt scale in of a MIG, it will be throttled as specified + by the parameters below. + properties: + maxScaledInReplicas: + $ref: '#/components/schemas/FixedOrPercent' + description: Maximum allowed number (or %) of VMs that can be deducted from + the peak recommendation during the window autoscaler looks at when computing + recommendations. Possibly all these VMs can be deleted at once so user + service needs to be prepared to lose that many VMs in one step. + timeWindowSec: + description: How far back autoscaling looks when computing recommendations + to include directives regarding slower scale in, as described above. + format: int32 + type: integer + type: object + AutoscalingPolicyScalingSchedule: + description: Scaling based on user-defined schedule. The message describes a + single scaling schedule. A scaling schedule changes the minimum number of + VM instances an autoscaler can recommend, which can trigger scaling out. + properties: + description: + description: A description of a scaling schedule. + type: string + disabled: + description: A boolean value that specifies whether a scaling schedule can + influence autoscaler recommendations. If set to true, then a scaling schedule + has no effect. This field is optional, and its value is false by default. + type: boolean + durationSec: + description: The duration of time intervals, in seconds, for which this + scaling schedule is to run. The minimum allowed value is 300. This field + is required. + format: int32 + type: integer + minRequiredReplicas: + description: The minimum number of VM instances that the autoscaler will + recommend in time intervals starting according to schedule. This field + is required. + format: int32 + type: integer + schedule: + description: 'The start timestamps of time intervals when this scaling schedule + is to provide a scaling signal. This field uses the extended cron format + (with an optional year field). The expression can describe a single timestamp + if the optional year is set, in which case the scaling schedule runs once. + The schedule is interpreted with respect to time_zone. This field is required. + Note: These timestamps only describe when autoscaler starts providing + the scaling signal. The VMs need additional time to become serving.' + type: string + timeZone: + description: "The time zone to use when interpreting the schedule. The value\ + \ of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.\ + \ This field is assigned a default value of \u201CUTC\u201D if left empty." + type: string + type: object + Backend: + description: Message containing information of one individual backend. + properties: + balancingMode: + description: 'Specifies how to determine whether the backend of a load balancer + can handle additional traffic or is fully loaded. For usage guidelines, + see Connection balancing mode. Backends must use compatible balancing + modes. For more information, see Supported balancing modes and target + capacity settings and Restrictions and guidance for instance groups. Note: + Currently, if you use the API to configure incompatible balancing modes, + the configuration might be accepted even though it has no impact and is + ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode + is RATE. In the future, this incompatible combination will be rejected.' + enum: + - CONNECTION + - RATE + - UTILIZATION + type: string + capacityScaler: + description: A multiplier applied to the backend's target capacity of its + balancing mode. The default value is 1, which means the group serves up + to 100% of its configured capacity (depending on balancingMode). A setting + of 0 means the group is completely drained, offering 0% of its available + capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure + a setting larger than 0 and smaller than 0.1. You cannot configure a setting + of 0 when there is only one backend attached to the backend service. + format: float + type: number + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + failover: + description: This field designates whether this is a failover backend. More + than one failover backend can be configured for a given BackendService. + type: boolean + group: + description: The fully-qualified URL of an instance group or network endpoint + group (NEG) resource. To determine what types of backends a load balancer + supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). + You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) + to specify the instance group or NEG. Partial URLs are not supported. + type: string + maxConnections: + description: Defines a target maximum number of simultaneous connections. + For usage guidelines, see Connection balancing mode and Utilization balancing + mode. Not available if the backend's balancingMode is RATE. + format: int32 + type: integer + maxConnectionsPerEndpoint: + description: Defines a target maximum number of simultaneous connections. + For usage guidelines, see Connection balancing mode and Utilization balancing + mode. Not available if the backend's balancingMode is RATE. + format: int32 + type: integer + maxConnectionsPerInstance: + description: Defines a target maximum number of simultaneous connections. + For usage guidelines, see Connection balancing mode and Utilization balancing + mode. Not available if the backend's balancingMode is RATE. + format: int32 + type: integer + maxRate: + description: Defines a maximum number of HTTP requests per second (RPS). + For usage guidelines, see Rate balancing mode and Utilization balancing + mode. Not available if the backend's balancingMode is CONNECTION. + format: int32 + type: integer + maxRatePerEndpoint: + description: Defines a maximum target for requests per second (RPS). For + usage guidelines, see Rate balancing mode and Utilization balancing mode. + Not available if the backend's balancingMode is CONNECTION. + format: float + type: number + maxRatePerInstance: + description: Defines a maximum target for requests per second (RPS). For + usage guidelines, see Rate balancing mode and Utilization balancing mode. + Not available if the backend's balancingMode is CONNECTION. + format: float + type: number + maxUtilization: + description: Optional parameter to define a target capacity for the UTILIZATIONbalancing + mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization + balancing mode. + format: float + type: number + type: object + BackendBucket: + description: Represents a Cloud Storage Bucket resource. This Cloud Storage + bucket resource is referenced by a URL map of a load balancer. For more information, + read Backend Buckets. + properties: + bucketName: + description: Cloud Storage bucket name. + type: string + cdnPolicy: + $ref: '#/components/schemas/BackendBucketCdnPolicy' + description: Cloud CDN configuration for this BackendBucket. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customResponseHeaders: + description: Headers that the HTTP/S load balancer should add to proxied + responses. + items: + type: string + type: array + description: + description: An optional textual description of the resource; provided by + the client when the resource is created. + type: string + enableCdn: + description: If true, enable Cloud CDN for this BackendBucket. + type: boolean + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + format: uint64 + type: string + kind: + default: compute#backendBucket + description: Type of the resource. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + BackendBucketCdnPolicy: + description: Message containing Cloud CDN configuration for a backend bucket. + properties: + bypassCacheOnRequestHeaders: + description: Bypass the cache when the specified request headers are matched + - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. + The cache is bypassed for all cdnPolicy.cacheMode settings. + items: + $ref: '#/components/schemas/BackendBucketCdnPolicyBypassCacheOnRequestHeader' + type: array + cacheMode: + description: 'Specifies the cache setting for all responses from this backend. + The possible values are: USE_ORIGIN_HEADERS Requires the origin to set + valid caching headers to cache content. Responses without these headers + will not be cached at Google''s edge, and will require a full trip to + the origin on every request, potentially impacting performance and increasing + load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring + any "private", "no-store" or "no-cache" directives in Cache-Control response + headers. Warning: this may result in Cloud CDN caching private, per-user + (user identifiable) content. CACHE_ALL_STATIC Automatically cache static + content, including common image formats, media (video and audio), and + web assets (JavaScript and CSS). Requests and responses that are marked + as uncacheable, as well as dynamic content (including HTML), will not + be cached.' + enum: + - CACHE_ALL_STATIC + - FORCE_CACHE_ALL + - INVALID_CACHE_MODE + - USE_ORIGIN_HEADERS + type: string + clientTtl: + description: Specifies a separate client (e.g. browser client) maximum TTL. + This is used to clamp the max-age (or Expires) value sent to the client. + With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used + for the response max-age directive, along with a "public" directive. For + cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age + from the origin (if specified), or else sets the response max-age directive + to the lesser of the client_ttl and default_ttl, and also ensures a "public" + cache-control directive is present. If a client TTL is not specified, + a default value (1 hour) will be used. The maximum allowed value is 31,622,400s + (1 year). + format: int32 + type: integer + defaultTtl: + description: Specifies the default TTL for cached content served by this + origin for responses that do not have an existing valid TTL (max-age or + s-max-age). Setting a TTL of "0" means "always revalidate". The value + of defaultTTL cannot be set to a value greater than that of maxTTL, but + can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL + will overwrite the TTL set in all responses. The maximum allowed value + is 31,622,400s (1 year), noting that infrequently accessed objects may + be evicted from the cache before the defined TTL. + format: int32 + type: integer + maxTtl: + description: Specifies the maximum allowed TTL for cached content served + by this origin. Cache directives that attempt to set a max-age or s-maxage + higher than this, or an Expires header more than maxTTL seconds in the + future will be capped at the value of maxTTL, as if it were the value + of an s-maxage Cache-Control directive. Headers sent to the client will + not be modified. Setting a TTL of "0" means "always revalidate". The maximum + allowed value is 31,622,400s (1 year), noting that infrequently accessed + objects may be evicted from the cache before the defined TTL. + format: int32 + type: integer + negativeCaching: + description: 'Negative caching allows per-status code TTLs to be set, in + order to apply fine-grained caching for common errors or redirects. This + can reduce the load on your origin and improve end-user experience by + reducing response latency. When the cache mode is set to CACHE_ALL_STATIC + or USE_ORIGIN_HEADERS, negative caching applies to responses with the + specified response code that lack any Cache-Control, Expires, or Pragma: + no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative + caching applies to all responses with the specified response code, and + override any caching headers. By default, Cloud CDN will apply the following + default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 + (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable + For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected + Request), 501 (Not Implemented): 60s. These defaults can be overridden + in negative_caching_policy.' + type: boolean + negativeCachingPolicy: + description: Sets a cache TTL for the specified HTTP status code. negative_caching + must be enabled to configure negative_caching_policy. Omitting the policy + and leaving negative_caching enabled will use Cloud CDN's default cache + TTLs. Note that when specifying an explicit negative_caching_policy, you + should take care to specify a cache TTL for all response codes that you + wish to cache. Cloud CDN will not apply any default negative caching when + a policy exists. + items: + $ref: '#/components/schemas/BackendBucketCdnPolicyNegativeCachingPolicy' + type: array + requestCoalescing: + description: If true then Cloud CDN will combine multiple concurrent cache + fill requests into a small number of requests to the origin. + type: boolean + serveWhileStale: + description: Serve existing content from the cache (if available) when revalidating + content with the origin, or when an error is encountered when refreshing + the cache. This setting defines the default "max-stale" duration for any + cached responses that do not specify a max-stale directive. Stale responses + that exceed the TTL configured here will not be served. The default limit + (max-stale) is 86400s (1 day), which will allow stale content to be served + up to this limit beyond the max-age (or s-max-age) of a cached response. + The maximum allowed value is 604800 (1 week). Set this to zero (0) to + disable serve-while-stale. + format: int32 + type: integer + signedUrlCacheMaxAgeSec: + description: 'Maximum number of seconds the response to a signed URL request + will be considered fresh. After this time period, the response will be + revalidated before being served. Defaults to 1hr (3600s). When serving + responses to signed URL requests, Cloud CDN will internally behave as + though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" + header, regardless of any existing Cache-Control header. The actual headers + served in responses will not be altered.' + format: int64 + type: string + signedUrlKeyNames: + description: '[Output Only] Names of the keys for signing request URLs.' + items: + type: string + type: array + type: object + BackendBucketCdnPolicyBypassCacheOnRequestHeader: + description: Bypass the cache when the specified request headers are present, + e.g. Pragma or Authorization headers. Values are case insensitive. The presence + of such a header overrides the cache_mode setting. + properties: + headerName: + description: The header field name to match on when bypassing cache. Values + are case-insensitive. + type: string + type: object + BackendBucketCdnPolicyNegativeCachingPolicy: + description: Specify CDN TTLs for response error codes. + properties: + code: + description: The HTTP status code to define a TTL against. Only HTTP status + codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can + be specified as values, and you cannot specify a status code more than + once. + format: int32 + type: integer + ttl: + description: The TTL (in seconds) for which to cache responses with the + corresponding status code. The maximum allowed value is 1800s (30 minutes), + noting that infrequently accessed objects may be evicted from the cache + before the defined TTL. + format: int32 + type: integer + type: object + BackendBucketList: + description: Contains a list of BackendBucket resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of BackendBucket resources. + items: + $ref: '#/components/schemas/BackendBucket' + type: array + kind: + default: compute#backendBucketList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + BackendService: + description: Represents a Backend Service resource. A backend service defines + how Google Cloud load balancers distribute traffic. The backend service configuration + contains a set of values, such as the protocol used to connect to backends, + various distribution and session settings, health checks, and timeouts. These + settings provide fine-grained control over how your load balancer behaves. + Most of the settings have default values that allow for easy configuration + if you need to get started quickly. Backend services in Google Compute Engine + can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) + * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) + For more information, see Backend Services. + properties: + affinityCookieTtlSec: + description: Lifetime of cookies in seconds. This setting is applicable + to external and internal HTTP(S) load balancers and Traffic Director and + requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, + the cookie is non-persistent and lasts only until the end of the browser + session (or equivalent). The maximum allowed value is one day (86,400). + 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. + format: int32 + type: integer + backends: + description: The list of backends that serve this BackendService. + items: + $ref: '#/components/schemas/Backend' + type: array + cdnPolicy: + $ref: '#/components/schemas/BackendServiceCdnPolicy' + description: Cloud CDN configuration for this BackendService. Only available + for specified load balancer types. + circuitBreakers: + $ref: '#/components/schemas/CircuitBreakers' + connectionDraining: + $ref: '#/components/schemas/ConnectionDraining' + consistentHash: + $ref: '#/components/schemas/ConsistentHashLoadBalancerSettings' + description: 'Consistent Hash-based load balancing can be used to provide + soft session affinity based on HTTP headers, cookies or other properties. + This load balancing policy is applicable only for HTTP connections. The + affinity to a particular destination host will be lost when one or more + hosts are added/removed from the destination service. This field specifies + parameters that control consistent hashing. This field is only applicable + when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable + to either: - A regional backend service with the service_protocol set + to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. + - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + 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.' + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customRequestHeaders: + description: Headers that the load balancer adds to proxied requests. See + [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). + items: + type: string + type: array + customResponseHeaders: + description: Headers that the load balancer adds to proxied responses. See + [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). + items: + type: string + type: array + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + enableCDN: + description: If true, enables Cloud CDN for the backend service of an external + HTTP(S) load balancer. + type: boolean + failoverPolicy: + $ref: '#/components/schemas/BackendServiceFailoverPolicy' + description: 'Requires at least one backend instance group to be defined + as a backup (failover) backend. For load balancers that have configurable + failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external TCP/UDP Load Balancing](/network/networklb-failover-overview).' + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a BackendService. An up-to-date fingerprint + must be provided in order to update the BackendService, otherwise the + request will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve a BackendService. + format: byte + type: string + healthChecks: + description: The list of URLs to the healthChecks, httpHealthChecks (legacy), + or httpsHealthChecks (legacy) resource for health checking this backend + service. Not all backend services support legacy health checks. See Load + balancer guide. Currently, at most one health check can be specified for + each backend service. Backend services with instance group or zonal NEG + backends must have a health check. Backend services with internet or serverless + NEG backends must not have a health check. + items: + type: string + type: array + iap: + $ref: '#/components/schemas/BackendServiceIAP' + description: The configurations for Identity-Aware Proxy on this resource. + Not available for Internal TCP/UDP Load Balancing and Network Load Balancing. + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#backendService + description: '[Output Only] Type of resource. Always compute#backendService + for backend services.' + type: string + loadBalancingScheme: + description: Specifies the load balancer type. A backend service created + for one type of load balancer cannot be used with another. For more information, + refer to Choosing a load balancer. + enum: + - EXTERNAL + - INTERNAL + - INTERNAL_MANAGED + - INTERNAL_SELF_MANAGED + - INVALID_LOAD_BALANCING_SCHEME + type: string + localityLbPolicy: + description: 'The load balancing algorithm used within the scope of the + locality. The possible values are: - ROUND_ROBIN: This is a simple policy + in which each healthy backend is selected in round robin order. This is + the default. - LEAST_REQUEST: An O(1) algorithm which selects two random + healthy hosts and picks the host which has fewer active requests. - RING_HASH: + The ring/modulo hash load balancer implements consistent hashing to backends. + The algorithm has the property that the addition/removal of a host from + a set of N hosts only affects 1/N of the requests. - RANDOM: The load + balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend + host is selected based on the client connection metadata, i.e., connections + are opened to the same address as the destination address of the incoming + connection before the connection was redirected to the load balancer. + - MAGLEV: used as a drop in replacement for the ring hash load balancer. + Maglev is not as stable as ring hash but has faster table lookup build + times and host selection times. For more information about Maglev, see + https://ai.google/research/pubs/pub44824 This field is applicable to either: + - A regional backend service with the service_protocol set to HTTP, HTTPS, + or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global + backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + If sessionAffinity is not NONE, and this field is not set to MAGLEV or + RING_HASH, session affinity settings will not take effect. Only the default + ROUND_ROBIN policy is 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.' + enum: + - INVALID_LB_POLICY + - LEAST_REQUEST + - MAGLEV + - ORIGINAL_DESTINATION + - RANDOM + - RING_HASH + - ROUND_ROBIN + type: string + logConfig: + $ref: '#/components/schemas/BackendServiceLogConfig' + description: This field denotes the logging options for the load balancer + traffic served by this backend service. If logging is enabled, logs will + be exported to Stackdriver. + maxStreamDuration: + $ref: '#/components/schemas/Duration' + description: Specifies the default maximum duration (timeout) for streams + to this service. Duration is computed from the beginning of the stream + until the response has been completely processed, including all retries. + A stream that does not complete in this duration is closed. If not specified, + there will be no timeout limit, i.e. the maximum duration is infinite. + This value can be overridden in the PathMatcher configuration of the UrlMap + that references this backend service. This field is only allowed when + the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED. + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: 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. + type: string + outlierDetection: + $ref: '#/components/schemas/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, or HTTP2, + and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend + service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. 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: + 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 + portName: + description: 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. + type: string + protocol: + description: The protocol this BackendService uses to communicate with backends. + Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending + on the chosen load balancer or Traffic Director configuration. Refer to + the documentation for the load balancers or for Traffic Director for more + information. Must be set to GRPC when the backend service is referenced + by a URL map that is bound to target gRPC proxy. + enum: + - GRPC + - HTTP + - HTTP2 + - HTTPS + - SSL + - TCP + - UDP + type: string + region: + description: '[Output Only] URL of the region where the regional backend + service resides. This field is not applicable to global backend services. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + securityPolicy: + description: '[Output Only] The resource URL for the security policy associated + with this backend service.' + type: string + securitySettings: + $ref: '#/components/schemas/SecuritySettings' + description: 'This field specifies the security policy that applies to this + backend service. This field is applicable to either: - A regional backend + service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme + set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme + set to INTERNAL_SELF_MANAGED. ' + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sessionAffinity: + description: 'Type of session affinity to use. The default is NONE. For + a detailed description of session affinity options, see: [Session affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + 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.' + enum: + - CLIENT_IP + - CLIENT_IP_NO_DESTINATION + - CLIENT_IP_PORT_PROTO + - CLIENT_IP_PROTO + - GENERATED_COOKIE + - HEADER_FIELD + - HTTP_COOKIE + - NONE + type: string + subsetting: + $ref: '#/components/schemas/Subsetting' + timeoutSec: + description: 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. Instead, use maxStreamDuration. + format: int32 + type: integer + type: object + BackendServiceAggregatedList: + description: Contains a list of BackendServicesScopedList. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/BackendServicesScopedList' + description: Name of the scope containing this set of BackendServices. + description: A list of BackendServicesScopedList resources. + type: object + kind: + default: compute#backendServiceAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + BackendServiceCdnPolicy: + description: Message containing Cloud CDN configuration for a backend service. + properties: + bypassCacheOnRequestHeaders: + description: Bypass the cache when the specified request headers are matched + - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. + The cache is bypassed for all cdnPolicy.cacheMode settings. + items: + $ref: '#/components/schemas/BackendServiceCdnPolicyBypassCacheOnRequestHeader' + type: array + cacheKeyPolicy: + $ref: '#/components/schemas/CacheKeyPolicy' + description: The CacheKeyPolicy for this CdnPolicy. + cacheMode: + description: 'Specifies the cache setting for all responses from this backend. + The possible values are: USE_ORIGIN_HEADERS Requires the origin to set + valid caching headers to cache content. Responses without these headers + will not be cached at Google''s edge, and will require a full trip to + the origin on every request, potentially impacting performance and increasing + load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring + any "private", "no-store" or "no-cache" directives in Cache-Control response + headers. Warning: this may result in Cloud CDN caching private, per-user + (user identifiable) content. CACHE_ALL_STATIC Automatically cache static + content, including common image formats, media (video and audio), and + web assets (JavaScript and CSS). Requests and responses that are marked + as uncacheable, as well as dynamic content (including HTML), will not + be cached.' + enum: + - CACHE_ALL_STATIC + - FORCE_CACHE_ALL + - INVALID_CACHE_MODE + - USE_ORIGIN_HEADERS + type: string + clientTtl: + description: Specifies a separate client (e.g. browser client) maximum TTL. + This is used to clamp the max-age (or Expires) value sent to the client. + With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used + for the response max-age directive, along with a "public" directive. For + cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age + from the origin (if specified), or else sets the response max-age directive + to the lesser of the client_ttl and default_ttl, and also ensures a "public" + cache-control directive is present. If a client TTL is not specified, + a default value (1 hour) will be used. The maximum allowed value is 31,622,400s + (1 year). + format: int32 + type: integer + defaultTtl: + description: Specifies the default TTL for cached content served by this + origin for responses that do not have an existing valid TTL (max-age or + s-max-age). Setting a TTL of "0" means "always revalidate". The value + of defaultTTL cannot be set to a value greater than that of maxTTL, but + can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL + will overwrite the TTL set in all responses. The maximum allowed value + is 31,622,400s (1 year), noting that infrequently accessed objects may + be evicted from the cache before the defined TTL. + format: int32 + type: integer + maxTtl: + description: Specifies the maximum allowed TTL for cached content served + by this origin. Cache directives that attempt to set a max-age or s-maxage + higher than this, or an Expires header more than maxTTL seconds in the + future will be capped at the value of maxTTL, as if it were the value + of an s-maxage Cache-Control directive. Headers sent to the client will + not be modified. Setting a TTL of "0" means "always revalidate". The maximum + allowed value is 31,622,400s (1 year), noting that infrequently accessed + objects may be evicted from the cache before the defined TTL. + format: int32 + type: integer + negativeCaching: + description: 'Negative caching allows per-status code TTLs to be set, in + order to apply fine-grained caching for common errors or redirects. This + can reduce the load on your origin and improve end-user experience by + reducing response latency. When the cache mode is set to CACHE_ALL_STATIC + or USE_ORIGIN_HEADERS, negative caching applies to responses with the + specified response code that lack any Cache-Control, Expires, or Pragma: + no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative + caching applies to all responses with the specified response code, and + override any caching headers. By default, Cloud CDN will apply the following + default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 + (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable + For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected + Request), 501 (Not Implemented): 60s. These defaults can be overridden + in negative_caching_policy.' + type: boolean + negativeCachingPolicy: + description: Sets a cache TTL for the specified HTTP status code. negative_caching + must be enabled to configure negative_caching_policy. Omitting the policy + and leaving negative_caching enabled will use Cloud CDN's default cache + TTLs. Note that when specifying an explicit negative_caching_policy, you + should take care to specify a cache TTL for all response codes that you + wish to cache. Cloud CDN will not apply any default negative caching when + a policy exists. + items: + $ref: '#/components/schemas/BackendServiceCdnPolicyNegativeCachingPolicy' + type: array + requestCoalescing: + description: If true then Cloud CDN will combine multiple concurrent cache + fill requests into a small number of requests to the origin. + type: boolean + serveWhileStale: + description: Serve existing content from the cache (if available) when revalidating + content with the origin, or when an error is encountered when refreshing + the cache. This setting defines the default "max-stale" duration for any + cached responses that do not specify a max-stale directive. Stale responses + that exceed the TTL configured here will not be served. The default limit + (max-stale) is 86400s (1 day), which will allow stale content to be served + up to this limit beyond the max-age (or s-max-age) of a cached response. + The maximum allowed value is 604800 (1 week). Set this to zero (0) to + disable serve-while-stale. + format: int32 + type: integer + signedUrlCacheMaxAgeSec: + description: 'Maximum number of seconds the response to a signed URL request + will be considered fresh. After this time period, the response will be + revalidated before being served. Defaults to 1hr (3600s). When serving + responses to signed URL requests, Cloud CDN will internally behave as + though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" + header, regardless of any existing Cache-Control header. The actual headers + served in responses will not be altered.' + format: int64 + type: string + signedUrlKeyNames: + description: '[Output Only] Names of the keys for signing request URLs.' + items: + type: string + type: array + type: object + BackendServiceCdnPolicyBypassCacheOnRequestHeader: + description: Bypass the cache when the specified request headers are present, + e.g. Pragma or Authorization headers. Values are case insensitive. The presence + of such a header overrides the cache_mode setting. + properties: + headerName: + description: The header field name to match on when bypassing cache. Values + are case-insensitive. + type: string + type: object + BackendServiceCdnPolicyNegativeCachingPolicy: + description: Specify CDN TTLs for response error codes. + properties: + code: + description: The HTTP status code to define a TTL against. Only HTTP status + codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can + be specified as values, and you cannot specify a status code more than + once. + format: int32 + type: integer + ttl: + description: The TTL (in seconds) for which to cache responses with the + corresponding status code. The maximum allowed value is 1800s (30 minutes), + noting that infrequently accessed objects may be evicted from the cache + before the defined TTL. + format: int32 + type: integer + type: object + BackendServiceFailoverPolicy: + description: 'For load balancers that have configurable failover: [Internal + TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external TCP/UDP Load Balancing](/network/networklb-failover-overview). + On failover or failback, this field indicates whether connection draining + will be honored. Google Cloud has a fixed connection draining timeout of 10 + minutes. A setting of true terminates existing TCP connections to the active + pool during failover and failback, immediately draining traffic. A setting + of false allows existing TCP connections to persist, even on VMs no longer + in the active pool, for up to the duration of the connection draining timeout + (10 minutes).' + properties: + disableConnectionDrainOnFailover: + description: This can be set to true only if the protocol is TCP. The default + is false. + type: boolean + dropTrafficIfUnhealthy: + description: 'If set to true, connections to the load balancer are dropped + when all primary and all backup backend VMs are unhealthy.If set to false, + connections are distributed among all primary VMs when all primary and + all backup backend VMs are unhealthy. For load balancers that have configurable + failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external TCP/UDP Load Balancing](/network/networklb-failover-overview). + The default is false.' + type: boolean + failoverRatio: + description: 'The value of the field must be in the range [0, 1]. If the + value is 0, the load balancer performs a failover when the number of healthy + primary VMs equals zero. For all other values, the load balancer performs + a failover when the total number of healthy primary VMs is less than this + ratio. For load balancers that have configurable failover: [Internal TCP/UDP + Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external TCP/UDP Load Balancing](/network/networklb-failover-overview).' + format: float + type: number + type: object + BackendServiceGroupHealth: + properties: + annotations: + additionalProperties: + type: string + description: Metadata defined as annotations on the network endpoint group. + type: object + healthStatus: + description: Health state of the backend instances or endpoints in requested + instance or network endpoint group, determined based on configured health + checks. + items: + $ref: '#/components/schemas/HealthStatus' + type: array + kind: + default: compute#backendServiceGroupHealth + description: '[Output Only] Type of resource. Always compute#backendServiceGroupHealth + for the health of backend services.' + type: string + type: object + BackendServiceIAP: + description: Identity-Aware Proxy + properties: + enabled: + description: Whether the serving infrastructure will authenticate and authorize + all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret + fields must be non-empty. + type: boolean + oauth2ClientId: + description: OAuth2 client ID to use for the authentication flow. + type: string + oauth2ClientSecret: + description: OAuth2 client secret to use for the authentication flow. For + security reasons, this value cannot be retrieved via the API. Instead, + the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 + field. @InputOnly + type: string + oauth2ClientSecretSha256: + description: '[Output Only] SHA256 hash value for the field oauth2_client_secret + above.' + type: string + type: object + BackendServiceList: + description: Contains a list of BackendService resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of BackendService resources. + items: + $ref: '#/components/schemas/BackendService' + type: array + kind: + default: compute#backendServiceList + description: '[Output Only] Type of resource. Always compute#backendServiceList + for lists of backend services.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + BackendServiceLogConfig: + description: The available logging options for the load balancer traffic served + by this backend service. + properties: + enable: + description: This field denotes whether to enable logging for the load balancer + traffic served by this backend service. + type: boolean + sampleRate: + description: This field can only be specified if logging is enabled for + this backend service. The value of the field must be in [0, 1]. This configures + the sampling rate of requests to the load balancer where 1.0 means all + logged requests are reported and 0.0 means no logged requests are reported. + The default value is 1.0. + format: float + type: number + type: object + BackendServiceReference: + properties: + backendService: + type: string + type: object + BackendServicesScopedList: + properties: + backendServices: + description: A list of BackendServices contained in this scope. + items: + $ref: '#/components/schemas/BackendService' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + BfdPacket: + properties: + authenticationPresent: + description: The Authentication Present bit of the BFD packet. This is specified + in section 4.1 of RFC5880 + type: boolean + controlPlaneIndependent: + description: The Control Plane Independent bit of the BFD packet. This is + specified in section 4.1 of RFC5880 + type: boolean + demand: + description: The demand bit of the BFD packet. This is specified in section + 4.1 of RFC5880 + type: boolean + diagnostic: + description: The diagnostic code specifies the local system's reason for + the last change in session state. This allows remote systems to determine + the reason that the previous session failed, for example. These diagnostic + codes are specified in section 4.1 of RFC5880 + enum: + - ADMINISTRATIVELY_DOWN + - CONCATENATED_PATH_DOWN + - CONTROL_DETECTION_TIME_EXPIRED + - DIAGNOSTIC_UNSPECIFIED + - ECHO_FUNCTION_FAILED + - FORWARDING_PLANE_RESET + - NEIGHBOR_SIGNALED_SESSION_DOWN + - NO_DIAGNOSTIC + - PATH_DOWN + - REVERSE_CONCATENATED_PATH_DOWN + type: string + final: + description: The Final bit of the BFD packet. This is specified in section + 4.1 of RFC5880 + type: boolean + length: + description: The length of the BFD Control packet in bytes. This is specified + in section 4.1 of RFC5880 + format: uint32 + type: integer + minEchoRxIntervalMs: + description: The Required Min Echo RX Interval value in the BFD packet. + This is specified in section 4.1 of RFC5880 + format: uint32 + type: integer + minRxIntervalMs: + description: The Required Min RX Interval value in the BFD packet. This + is specified in section 4.1 of RFC5880 + format: uint32 + type: integer + minTxIntervalMs: + description: The Desired Min TX Interval value in the BFD packet. This is + specified in section 4.1 of RFC5880 + format: uint32 + type: integer + multiplier: + description: The detection time multiplier of the BFD packet. This is specified + in section 4.1 of RFC5880 + format: uint32 + type: integer + multipoint: + description: The multipoint bit of the BFD packet. This is specified in + section 4.1 of RFC5880 + type: boolean + myDiscriminator: + description: The My Discriminator value in the BFD packet. This is specified + in section 4.1 of RFC5880 + format: uint32 + type: integer + poll: + description: The Poll bit of the BFD packet. This is specified in section + 4.1 of RFC5880 + type: boolean + state: + description: The current BFD session state as seen by the transmitting system. + These states are specified in section 4.1 of RFC5880 + enum: + - ADMIN_DOWN + - DOWN + - INIT + - STATE_UNSPECIFIED + - UP + type: string + version: + description: The version number of the BFD protocol, as specified in section + 4.1 of RFC5880. + format: uint32 + type: integer + yourDiscriminator: + description: The Your Discriminator value in the BFD packet. This is specified + in section 4.1 of RFC5880 + format: uint32 + type: integer + type: object + BfdStatus: + description: 'Next free: 15' + properties: + bfdSessionInitializationMode: + description: The BFD session initialization mode for this BGP peer. If set + to ACTIVE, the Cloud Router will initiate the BFD session for this BGP + peer. If set to PASSIVE, the Cloud Router will wait for the peer router + to initiate the BFD session for this BGP peer. If set to DISABLED, BFD + is disabled for this BGP peer. + enum: + - ACTIVE + - DISABLED + - PASSIVE + type: string + configUpdateTimestampMicros: + description: Unix timestamp of the most recent config update. + format: int64 + type: string + controlPacketCounts: + $ref: '#/components/schemas/BfdStatusPacketCounts' + description: Control packet counts for the current BFD session. + controlPacketIntervals: + description: Inter-packet time interval statistics for control packets. + items: + $ref: '#/components/schemas/PacketIntervals' + type: array + localDiagnostic: + description: The diagnostic code specifies the local system's reason for + the last change in session state. This allows remote systems to determine + the reason that the previous session failed, for example. These diagnostic + codes are specified in section 4.1 of RFC5880 + enum: + - ADMINISTRATIVELY_DOWN + - CONCATENATED_PATH_DOWN + - CONTROL_DETECTION_TIME_EXPIRED + - DIAGNOSTIC_UNSPECIFIED + - ECHO_FUNCTION_FAILED + - FORWARDING_PLANE_RESET + - NEIGHBOR_SIGNALED_SESSION_DOWN + - NO_DIAGNOSTIC + - PATH_DOWN + - REVERSE_CONCATENATED_PATH_DOWN + type: string + localState: + description: The current BFD session state as seen by the transmitting system. + These states are specified in section 4.1 of RFC5880 + enum: + - ADMIN_DOWN + - DOWN + - INIT + - STATE_UNSPECIFIED + - UP + type: string + negotiatedLocalControlTxIntervalMs: + description: Negotiated transmit interval for control packets. + format: uint32 + type: integer + rxPacket: + $ref: '#/components/schemas/BfdPacket' + description: The most recent Rx control packet for this BFD session. + txPacket: + $ref: '#/components/schemas/BfdPacket' + description: The most recent Tx control packet for this BFD session. + uptimeMs: + description: Session uptime in milliseconds. Value will be 0 if session + is not up. + format: int64 + type: string + type: object + BfdStatusPacketCounts: + properties: + numRx: + description: Number of packets received since the beginning of the current + BFD session. + format: uint32 + type: integer + numRxRejected: + description: Number of packets received that were rejected because of errors + since the beginning of the current BFD session. + format: uint32 + type: integer + numRxSuccessful: + description: Number of packets received that were successfully processed + since the beginning of the current BFD session. + format: uint32 + type: integer + numTx: + description: Number of packets transmitted since the beginning of the current + BFD session. + format: uint32 + type: integer + type: object + Binding: + description: Associates `members` with a `role`. + properties: + bindingId: + description: This is deprecated and has no effect. Do not use. + type: string + condition: + $ref: '#/components/schemas/Expr' + description: The condition that is associated with this binding. If the + condition evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding does + not apply to the current request. However, a different role binding might + grant the same role to one or more of the members in this binding. To + learn which resources support conditions in their IAM policies, see the + [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + members: + description: 'Specifies the identities requesting access for a Cloud Platform + resource. `members` can have the following values: * `allUsers`: A special + identifier that represents anyone who is on the internet; with or without + a Google account. * `allAuthenticatedUsers`: A special identifier that + represents anyone who is authenticated with a Google account or a service + account. * `user:{emailid}`: An email address that represents a specific + Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: + An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. + * `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a user that has + been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and the + recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a service account + that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` + and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google group + that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. + If the group is recovered, this value reverts to `group:{emailid}` and + the recovered group retains the role in the binding. * `domain:{domain}`: + The G Suite domain (primary) that represents all the users of that domain. + For example, `google.com` or `example.com`. ' + items: + type: string + type: array + role: + description: Role that is assigned to `members`. For example, `roles/viewer`, + `roles/editor`, or `roles/owner`. + type: string + type: object + BulkInsertInstanceResource: + description: A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert + . This resource is not persisted anywhere, it is used only for processing + the requests. + properties: + count: + description: The maximum number of instances to create. + format: int64 + type: string + instanceProperties: + $ref: '#/components/schemas/InstanceProperties' + description: The instance properties defining the VM instances to be created. + Required if sourceInstanceTemplate is not provided. + locationPolicy: + $ref: '#/components/schemas/LocationPolicy' + description: Policy for chosing target zone. + minCount: + description: The minimum number of instances to create. If no min_count + is specified then count is used as the default value. If min_count instances + cannot be created, then no instances will be created and instances already + created will be deleted. + format: int64 + type: string + namePattern: + description: 'The string pattern used for the names of the VMs. Either name_pattern + or per_instance_properties must be set. The pattern must contain one continuous + sequence of placeholder hash characters (#) with each character corresponding + to one digit of the generated instance name. Example: a name_pattern of + inst-#### generates instance names such as inst-0001 and inst-0002. If + existing instances in the same project and zone have names that match + the name pattern then the generated instance numbers start after the biggest + existing number. For example, if there exists an instance with name inst-0050, + then instance names generated using the pattern inst-#### begin with inst-0051. + The name pattern placeholder #...# can contain up to 18 characters.' + type: string + perInstanceProperties: + additionalProperties: + $ref: '#/components/schemas/BulkInsertInstanceResourcePerInstanceProperties' + description: Per-instance properties to be set on individual instances. + Keys of this map specify requested instance names. Can be empty if name_pattern + is used. + type: object + sourceInstanceTemplate: + description: 'Specifies the instance template from which to create instances. + You may combine sourceInstanceTemplate with instanceProperties to override + specific values from an existing instance template. Bulk API follows the + semantics of JSON Merge Patch described by RFC 7396. It can be a full + or partial URL. For example, the following are all valid URLs to an instance + template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate + - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate + This field is optional.' + type: string + type: object + BulkInsertInstanceResourcePerInstanceProperties: + description: Per-instance properties to be set on individual instances. To be + extended in the future. + properties: + name: + description: This field is only temporary. It will be removed. Do not use + it. + type: string + type: object + CacheInvalidationRule: + properties: + host: + description: If set, this invalidation rule will only apply to requests + with a Host header matching host. + type: string + path: + type: string + type: object + CacheKeyPolicy: + description: Message containing what to include in the cache key for a request + for Cloud CDN. + properties: + includeHost: + description: If true, requests to different hosts will be cached separately. + type: boolean + includeProtocol: + description: If true, http and https requests will be cached separately. + type: boolean + includeQueryString: + description: If true, include query string parameters in the cache key according + to query_string_whitelist and query_string_blacklist. If neither is set, + the entire query string will be included. If false, the query string will + be excluded from the cache key entirely. + type: boolean + queryStringBlacklist: + description: Names of query string parameters to exclude in cache keys. + All other parameters will be included. Either specify query_string_whitelist + or query_string_blacklist, not both. '&' and '=' will be percent encoded + and not treated as delimiters. + items: + type: string + type: array + queryStringWhitelist: + description: Names of query string parameters to include in cache keys. + All other parameters will be excluded. Either specify query_string_whitelist + or query_string_blacklist, not both. '&' and '=' will be percent encoded + and not treated as delimiters. + items: + type: string + type: array + type: object + CircuitBreakers: + description: Settings controlling the volume of requests, connections and retries + to this backend service. + properties: + maxConnections: + description: 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. + format: int32 + type: integer + maxPendingRequests: + description: 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. + format: int32 + type: integer + maxRequests: + description: The maximum number of parallel requests that allowed to the + backend service. If not specified, there is no limit. + format: int32 + type: integer + maxRequestsPerConnection: + description: 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. + format: int32 + type: integer + maxRetries: + description: 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. + format: int32 + type: integer + type: object + Commitment: + description: Represents a regional Commitment resource. Creating a commitment + resource means that you are purchasing a committed use contract with an explicit + start and end time. You can create commitments based on vCPUs and memory usage + and receive discounted rates. For full details, read Signing Up for Committed + Use Discounts. + properties: + category: + description: The category of the commitment. Category MACHINE specifies + commitments composed of machine resources such as VCPU or MEMORY, listed + in resources. Category LICENSE specifies commitments composed of software + licenses, listed in licenseResources. Note that only MACHINE commitments + should have a Type specified. + enum: + - CATEGORY_UNSPECIFIED + - LICENSE + - MACHINE + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + endTimestamp: + description: '[Output Only] Commitment end time in RFC3339 text format.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#commitment + description: '[Output Only] Type of the resource. Always compute#commitment + for commitments.' + type: string + licenseResource: + $ref: '#/components/schemas/LicenseResourceCommitment' + description: The license specification required as part of a license commitment. + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + plan: + description: The plan for this commitment, which determines duration and + discount rate. The currently supported plans are TWELVE_MONTH (1 year), + and THIRTY_SIX_MONTH (3 years). + enum: + - INVALID + - THIRTY_SIX_MONTH + - TWELVE_MONTH + type: string + region: + description: '[Output Only] URL of the region where this commitment may + be used.' + type: string + reservations: + description: List of reservations in this commitment. + items: + $ref: '#/components/schemas/Reservation' + type: array + resources: + description: A list of commitment amounts for particular resources. Note + that VCPU and MEMORY resource commitments must occur together. + items: + $ref: '#/components/schemas/ResourceCommitment' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + startTimestamp: + description: '[Output Only] Commitment start time in RFC3339 text format.' + type: string + status: + description: '[Output Only] Status of the commitment with regards to eventual + expiration (each commitment has an end date defined). One of the following + values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.' + enum: + - ACTIVE + - CREATING + - EXPIRED + - NOT_YET_ACTIVE + type: string + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the + status.' + type: string + type: + description: The type of commitment, which affects the discount rate and + the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that + will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED + specifies a commitment that will only apply to accelerator optimized machines. + enum: + - ACCELERATOR_OPTIMIZED + - COMPUTE_OPTIMIZED + - GENERAL_PURPOSE + - GENERAL_PURPOSE_E2 + - GENERAL_PURPOSE_N2 + - GENERAL_PURPOSE_N2D + - MEMORY_OPTIMIZED + - TYPE_UNSPECIFIED + type: string + type: object + CommitmentAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/CommitmentsScopedList' + description: '[Output Only] Name of the scope containing this set of commitments.' + description: A list of CommitmentsScopedList resources. + type: object + kind: + default: compute#commitmentAggregatedList + description: '[Output Only] Type of resource. Always compute#commitmentAggregatedList + for aggregated lists of commitments.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + CommitmentList: + description: Contains a list of Commitment resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Commitment resources. + items: + $ref: '#/components/schemas/Commitment' + type: array + kind: + default: compute#commitmentList + description: '[Output Only] Type of resource. Always compute#commitmentList + for lists of commitments.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + CommitmentsScopedList: + properties: + commitments: + description: '[Output Only] A list of commitments contained in this scope.' + items: + $ref: '#/components/schemas/Commitment' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of commitments 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Condition: + description: This is deprecated and has no effect. Do not use. + properties: + iam: + description: This is deprecated and has no effect. Do not use. + enum: + - APPROVER + - ATTRIBUTION + - AUTHORITY + - CREDENTIALS_TYPE + - CREDS_ASSERTION + - JUSTIFICATION_TYPE + - NO_ATTR + - SECURITY_REALM + type: string + op: + description: This is deprecated and has no effect. Do not use. + enum: + - DISCHARGED + - EQUALS + - IN + - NOT_EQUALS + - NOT_IN + - NO_OP + type: string + svc: + description: This is deprecated and has no effect. Do not use. + type: string + sys: + description: This is deprecated and has no effect. Do not use. + enum: + - IP + - NAME + - NO_ATTR + - REGION + - SERVICE + type: string + values: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + type: object + ConfidentialInstanceConfig: + description: A set of Confidential Instance options. + properties: + enableConfidentialCompute: + description: Defines whether the instance should have confidential compute + enabled. + type: boolean + type: object + ConnectionDraining: + description: Message containing connection draining configuration. + properties: + drainingTimeoutSec: + description: Configures a duration timeout for existing requests on a removed + backend instance. For supported load balancers and protocols, as described + in Enabling connection draining. + format: int32 + type: integer + type: object + ConsistentHashLoadBalancerSettings: + description: This message defines settings for a consistent hash style load + balancer. + properties: + httpCookie: + $ref: '#/components/schemas/ConsistentHashLoadBalancerSettingsHttpCookie' + description: Hash is based on HTTP Cookie. This field describes a HTTP cookie + that will be used as the hash key for the consistent hash load balancer. + If the cookie is not present, it will be generated. This field is applicable + if the sessionAffinity is set to HTTP_COOKIE. + httpHeaderName: + description: The hash based on the value of the specified header field. + This field is applicable if the sessionAffinity is set to HEADER_FIELD. + type: string + minimumRingSize: + description: The minimum number of virtual nodes to use for the hash ring. + Defaults to 1024. Larger ring sizes result in more granular load distributions. + If the number of hosts in the load balancing pool is larger than the ring + size, each host will be assigned a single virtual node. + format: int64 + type: string + type: object + ConsistentHashLoadBalancerSettingsHttpCookie: + description: The information about the HTTP Cookie on which the hash function + is based for load balancing policies that use a consistent hash. + properties: + name: + description: Name of the cookie. + type: string + path: + description: Path to set for the cookie. + type: string + ttl: + $ref: '#/components/schemas/Duration' + description: Lifetime of the cookie. + type: object + CorsPolicy: + description: The specification for allowing client side cross-origin requests. + Please see W3C Recommendation for Cross Origin Resource Sharing + properties: + allowCredentials: + description: In response to a preflight request, setting this to true indicates + that the actual request can include user credentials. This translates + to the Access-Control-Allow-Credentials header. Default is false. + type: boolean + allowHeaders: + description: Specifies the content for the Access-Control-Allow-Headers + header. + items: + type: string + type: array + allowMethods: + description: Specifies the content for the Access-Control-Allow-Methods + header. + items: + type: string + type: array + allowOriginRegexes: + description: Specifies the regualar expression patterns that match allowed + origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax + An origin is allowed if it matches either an item in allowOrigins or an + item in allowOriginRegexes. + items: + type: string + type: array + allowOrigins: + description: Specifies the list of origins that will be allowed to do CORS + requests. An origin is allowed if it matches either an item in allowOrigins + or an item in allowOriginRegexes. + items: + type: string + type: array + disabled: + description: If true, specifies the CORS policy is disabled. The default + value of false, which indicates that the CORS policy is in effect. + type: boolean + exposeHeaders: + description: Specifies the content for the Access-Control-Expose-Headers + header. + items: + type: string + type: array + maxAge: + description: Specifies how long results of a preflight request can be cached + in seconds. This translates to the Access-Control-Max-Age header. + format: int32 + type: integer + type: object + CustomerEncryptionKey: + properties: + kmsKeyName: + description: 'The name of the encryption key that is stored in Google Cloud + KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + key_region/cryptoKeys/key ' + type: string + kmsKeyServiceAccount: + description: 'The service account being used for the encryption request + for the given KMS key. If absent, the Compute Engine default service account + is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ ' + type: string + rawKey: + description: 'Specifies a 256-bit customer-supplied encryption key, encoded + in RFC 4648 base64 to either encrypt or decrypt this resource. You can + provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": + "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" ' + type: string + rsaEncryptedKey: + description: '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 ' + type: string + sha256: + description: '[Output only] The RFC 4648 base64 encoded SHA-256 hash of + the customer-supplied encryption key that protects this resource.' + type: string + type: object + CustomerEncryptionKeyProtectedDisk: + properties: + diskEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: Decrypts data associated with the disk with a customer-supplied + encryption key. + source: + description: 'Specifies a valid partial or full URL to an existing Persistent + Disk resource. This field is only applicable for persistent disks. For + example: "source": "/compute/v1/projects/project_id/zones/zone/disks/ + disk_name ' + type: string + type: object + DeprecationStatus: + description: Deprecation status for a public resource. + properties: + deleted: + description: An optional RFC3339 timestamp on or after which the state of + this resource is intended to change to DELETED. This is only informational + and the status will not change unless the client explicitly changes it. + type: string + deprecated: + description: An optional RFC3339 timestamp on or after which the state of + this resource is intended to change to DEPRECATED. This is only informational + and the status will not change unless the client explicitly changes it. + type: string + obsolete: + description: An optional RFC3339 timestamp on or after which the state of + this resource is intended to change to OBSOLETE. This is only informational + and the status will not change unless the client explicitly changes it. + type: string + replacement: + description: The URL of the suggested replacement for a deprecated resource. + The suggested replacement resource must be the same kind of resource as + the deprecated resource. + type: string + state: + description: The deprecation state of this resource. This can be ACTIVE, + DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end + of life date for an image, can use ACTIVE. Operations which create a new + resource using a DEPRECATED resource will return successfully, but with + a warning indicating the deprecated resource and recommending its replacement. + Operations which use OBSOLETE or DELETED resources will be rejected and + result in an error. + enum: + - ACTIVE + - DELETED + - DEPRECATED + - OBSOLETE + type: string + type: object + Disk: + description: 'Represents a Persistent Disk resource. Google Compute Engine has + two Disk resources: * [Zonal](/compute/docs/reference/rest/v1/disks) * [Regional](/compute/docs/reference/rest/v1/regionDisks) + Persistent disks are required for running your VM instances. Create both boot + and non-boot (data) persistent disks. For more information, read Persistent + Disks. For more storage options, read Storage options. The disks resource + represents a zonal persistent disk. For more information, read Zonal persistent + disks. The regionDisks resource represents a regional persistent disk. For + more information, read Regional resources.' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + diskEncryptionKey: + $ref: '#/components/schemas/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.' + 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. + items: + $ref: '#/components/schemas/GuestOsFeature' + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#disk + description: '[Output Only] Type of the resource. Always compute#disk for + disks.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this disk, which + is essentially a hash of the labels set used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve a disk. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this disk. These can be later modified by + the setLabels method. + type: object + lastAttachTimestamp: + description: '[Output Only] Last attach timestamp in RFC3339 text format.' + type: string + lastDetachTimestamp: + description: '[Output Only] Last detach timestamp in RFC3339 text format.' + type: string + licenseCodes: + description: Integer license codes indicating which licenses are attached + to this disk. + items: + format: int64 + type: string + type: array + licenses: + description: A list of publicly visible licenses. Reserved for Google's + use. + items: + type: string + type: array + locationHint: + description: An opaque location hint used to place the disk close to other + resources. This field is for use by internal tools that use the public + API. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + options: + description: Internal use only. + type: string + physicalBlockSizeBytes: + description: Physical block size of the persistent disk, in bytes. If not + present in a request, a default value is used. The currently supported + size is 4096, other sizes may be added in the future. If an unsupported + value is requested, the error message will list the supported values for + the caller's project. + format: int64 + type: string + provisionedIops: + description: Indicates how many IOPS to provision for the disk. This sets + the number of I/O operations per second that the disk can handle. Values + must be between 10,000 and 120,000. For more details, see the Extreme + persistent disk documentation. + format: int64 + type: string + region: + description: '[Output Only] URL of the region where the disk resides. Only + applicable for regional resources. You must specify this field as part + of the HTTP request URL. It is not settable as a field in the request + body.' + type: string + replicaZones: + description: URLs of the zones where the disk should be replicated to. Only + applicable for regional resources. + items: + type: string + type: array + resourcePolicies: + description: Resource policies applied to this disk for automatic snapshot + creations. + items: + type: string + type: array + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this + resource.' + type: string + sizeGb: + description: Size, in GB, of the persistent disk. You can specify this field + when creating a persistent disk using the sourceImage, sourceSnapshot, + or sourceDisk parameter, or specify it alone to create an empty persistent + disk. If you specify this field along with a source, the value of sizeGb + must not be less than the size of the source. Acceptable values are 1 + to 65536, inclusive. + format: int64 + type: string + sourceDisk: + description: 'The source disk used to create this disk. You can provide + this as a partial or full URL to the resource. For example, the following + are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region + /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk + - zones/zone/disks/disk - regions/region/disks/disk ' + type: string + sourceDiskId: + description: '[Output Only] The unique ID of the disk used to create this + disk. This value identifies the exact disk that was used to create this + persistent disk. For example, if you created the persistent disk from + a disk that was later deleted and recreated under the same name, the source + disk ID would identify the exact version of the disk that was used.' + type: string + sourceImage: + description: 'The source image used to create this disk. If the source image + is deleted, this field will not be set. To create a disk with one of the + public operating system images, specify the image by its family name. + For example, specify family/debian-9 to use the latest Debian 9 image: + projects/debian-cloud/global/images/family/debian-9 Alternatively, use + a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD + To create a disk with a custom image that you created, specify the image + name in the following format: global/images/my-custom-image You can also + specify a custom image by its image family, which returns the latest version + of the image in that family. Replace the image name with family/family-name: + global/images/family/my-image-family ' + type: string + sourceImageEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption key. + sourceImageId: + description: '[Output Only] The ID value of the image used to create this + disk. This value identifies the exact image that was used to create this + persistent disk. For example, if you created the persistent disk from + an image that was later deleted and recreated under the same name, the + source image ID would identify the exact version of the image that was + used.' + type: string + sourceSnapshot: + description: 'The source snapshot used to create this disk. You can provide + this as a partial or full URL to the resource. For example, the following + are valid values: - https://www.googleapis.com/compute/v1/projects/project + /global/snapshots/snapshot - projects/project/global/snapshots/snapshot + - global/snapshots/snapshot ' + type: string + sourceSnapshotEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source snapshot. + Required if the source snapshot is protected by a customer-supplied encryption + key. + sourceSnapshotId: + description: '[Output Only] The unique ID of the snapshot used to create + this disk. This value identifies the exact snapshot that was used to create + this persistent disk. For example, if you created the persistent disk + from a snapshot that was later deleted and recreated under the same name, + the source snapshot ID would identify the exact version of the snapshot + that was used.' + type: string + sourceStorageObject: + description: The full Google Cloud Storage URI where the disk image is stored. + This file must be a gzip-compressed tarball whose name ends in .tar.gz + or virtual machine disk whose name ends in vmdk. Valid URIs may start + with gs:// or https://storage.googleapis.com/. This flag is not optimized + for creating multiple disks from a source storage object. To create many + disks from a source storage object, use gcloud compute images import instead. + type: string + status: + description: '[Output Only] The status of disk creation. - CREATING: Disk + is provisioning. - RESTORING: Source data is being copied into the disk. + - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: + Disk is deleting. ' + enum: + - CREATING + - DELETING + - FAILED + - READY + - RESTORING + type: string + type: + description: 'URL of the disk type resource describing which disk type to + use to create the disk. Provide this when creating the disk. For example: + projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.' + type: string + users: + description: '[Output Only] Links to the users of the disk (attached instances) + in form: projects/project/zones/zone/instances/instance' + items: + type: string + type: array + zone: + description: '[Output Only] URL of the zone where the disk resides. You + must specify this field as part of the HTTP request URL. It is not settable + as a field in the request body.' + type: string + type: object + DiskAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/DisksScopedList' + description: '[Output Only] Name of the scope containing this set of disks.' + description: A list of DisksScopedList resources. + type: object + kind: + default: compute#diskAggregatedList + description: '[Output Only] Type of resource. Always compute#diskAggregatedList + for aggregated lists of persistent disks.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DiskInstantiationConfig: + description: A specification of the desired way to instantiate a disk in the + instance template when its created from a source instance. + properties: + autoDelete: + description: Specifies whether the disk will be auto-deleted when the instance + is deleted (but not when the disk is detached from the instance). + type: boolean + customImage: + description: The custom source image to be used to restore this disk when + instantiating this instance template. + type: string + deviceName: + description: Specifies the device name of the disk to which the configurations + apply to. + type: string + instantiateFrom: + description: 'Specifies whether to include the disk and what image to use. + Possible values are: - source-image: to use the same image that was used + to create the source instance''s corresponding disk. Applicable to the + boot disk and additional read-write disks. - source-image-family: to use + the same image family that was used to create the source instance''s corresponding + disk. Applicable to the boot disk and additional read-write disks. - custom-image: + to use a user-provided image url for disk creation. Applicable to the + boot disk and additional read-write disks. - attach-read-only: to attach + a read-only disk. Applicable to read-only disks. - do-not-include: to + exclude a disk from the template. Applicable to additional read-write + disks, local SSDs, and read-only disks. ' + enum: + - ATTACH_READ_ONLY + - BLANK + - CUSTOM_IMAGE + - DEFAULT + - DO_NOT_INCLUDE + - SOURCE_IMAGE + - SOURCE_IMAGE_FAMILY + type: string + type: object + DiskList: + description: A list of Disk resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Disk resources. + items: + $ref: '#/components/schemas/Disk' + type: array + kind: + default: compute#diskList + description: '[Output Only] Type of resource. Always compute#diskList for + lists of disks.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DiskMoveRequest: + properties: + destinationZone: + description: 'The URL of the destination zone to move the disk. This can + be a full or partial URL. For example, the following are all valid URLs + to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + - projects/project/zones/zone - zones/zone ' + type: string + targetDisk: + description: 'The URL of the target disk to move. This can be a full or + partial URL. For example, the following are all valid URLs to a disk: + - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk + - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ' + type: string + type: object + DiskType: + description: 'Represents a Disk Type resource. Google Compute Engine has two + Disk Type resources: * [Regional](/compute/docs/reference/rest/v1/regionDiskTypes) + * [Zonal](/compute/docs/reference/rest/v1/diskTypes) You can choose from a + variety of disk types based on your needs. For more information, read Storage + options. The diskTypes resource represents disk types for a zonal persistent + disk. For more information, read Zonal persistent disks. The regionDiskTypes + resource represents disk types for a regional persistent disk. For more information, + read Regional persistent disks.' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + defaultDiskSizeGb: + description: '[Output Only] Server-defined default disk size in GB.' + format: int64 + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + disk type.' + description: + description: '[Output Only] An optional description of this resource.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#diskType + description: '[Output Only] Type of the resource. Always compute#diskType + for disk types.' + type: string + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + region: + description: '[Output Only] URL of the region where the disk type resides. + Only applicable for regional resources. You must specify this field as + part of the HTTP request URL. It is not settable as a field in the request + body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + validDiskSize: + description: '[Output Only] An optional textual description of the valid + disk size, such as "10GB-10TB".' + type: string + zone: + description: '[Output Only] URL of the zone where the disk type resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + type: object + DiskTypeAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/DiskTypesScopedList' + description: '[Output Only] Name of the scope containing this set of disk + types.' + description: A list of DiskTypesScopedList resources. + type: object + kind: + default: compute#diskTypeAggregatedList + description: '[Output Only] Type of resource. Always compute#diskTypeAggregatedList.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DiskTypeList: + description: Contains a list of disk types. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of DiskType resources. + items: + $ref: '#/components/schemas/DiskType' + type: array + kind: + default: compute#diskTypeList + description: '[Output Only] Type of resource. Always compute#diskTypeList + for disk types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DiskTypesScopedList: + properties: + diskTypes: + description: '[Output Only] A list of disk types contained in this scope.' + items: + $ref: '#/components/schemas/DiskType' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of disk types 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DisksAddResourcePoliciesRequest: + properties: + resourcePolicies: + description: Full or relative path to the resource policy to be added to + this disk. You can only specify one resource policy. + items: + type: string + type: array + type: object + DisksRemoveResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be removed from this disk. + items: + type: string + type: array + type: object + DisksResizeRequest: + properties: + sizeGb: + description: The new size of the persistent disk, which is specified in + GB. + format: int64 + type: string + type: object + DisksScopedList: + properties: + disks: + description: '[Output Only] A list of disks contained in this scope.' + items: + $ref: '#/components/schemas/Disk' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of disks 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DisplayDevice: + description: A set of Display Device options + properties: + enableDisplay: + description: Defines whether the instance has Display enabled. + type: boolean + type: object + DistributionPolicy: + properties: + targetShape: + description: The distribution shape to which the group converges either + proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). + enum: + - ANY + - BALANCED + - EVEN + type: string + zones: + description: Zones where the regional managed instance group will create + and manage its instances. + items: + $ref: '#/components/schemas/DistributionPolicyZoneConfiguration' + type: array + type: object + DistributionPolicyZoneConfiguration: + properties: + zone: + description: The URL of the zone. The zone must exist in the region where + the managed instance group is located. + type: string + type: object + Duration: + description: 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. + properties: + nanos: + description: 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. + format: int32 + type: integer + seconds: + description: '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' + format: int64 + type: string + type: object + ExchangedPeeringRoute: + properties: + destRange: + description: The destination range of the route. + type: string + imported: + description: True if the peering route has been imported from a peer. The + actual import happens if the field networkPeering.importCustomRoutes is + true for this network, and networkPeering.exportCustomRoutes is true for + the peer network, and the import does not result in a route conflict. + type: boolean + nextHopRegion: + description: The region of peering route next hop, only applies to dynamic + routes. + type: string + priority: + description: The priority of the peering route. + format: uint32 + type: integer + type: + description: The type of the peering route. + enum: + - DYNAMIC_PEERING_ROUTE + - STATIC_PEERING_ROUTE + - SUBNET_PEERING_ROUTE + type: string + type: object + ExchangedPeeringRoutesList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of ExchangedPeeringRoute resources. + items: + $ref: '#/components/schemas/ExchangedPeeringRoute' + type: array + kind: + default: compute#exchangedPeeringRoutesList + description: '[Output Only] Type of resource. Always compute#exchangedPeeringRoutesList + for exchanged peering routes 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + 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.' + 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 + ExternalVpnGateway: + description: Represents an external VPN gateway. External VPN gateway is the + on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects + to your Google Cloud VPN gateway. To create a highly available VPN from Google + Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, + you must create a external VPN gateway resource with information about the + other gateway. For more information about using external VPN gateways, see + Creating an HA VPN gateway and tunnel pair to a peer VPN. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + interfaces: + description: A list of interfaces for this external VPN gateway. If your + peer-side gateway is an on-premises gateway and non-AWS cloud providers' + gateway, at most two interfaces can be provided for an external VPN gateway. + If your peer side is an AWS virtual private gateway, four interfaces should + be provided for an external VPN gateway. + items: + $ref: '#/components/schemas/ExternalVpnGatewayInterface' + type: array + kind: + default: compute#externalVpnGateway + description: '[Output Only] Type of the resource. Always compute#externalVpnGateway + for externalVpnGateways.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this ExternalVpnGateway, + which is essentially a hash of the labels set used for optimistic locking. + The fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve an ExternalVpnGateway. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels for this resource. These can only be added or modified + by the setLabels method. Each label key/value pair must comply with RFC1035. + Label values may be empty. + type: object + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + redundancyType: + description: Indicates the user-supplied redundancy type of this external + VPN gateway. + enum: + - FOUR_IPS_REDUNDANCY + - SINGLE_IP_INTERNALLY_REDUNDANT + - TWO_IPS_REDUNDANCY + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + ExternalVpnGatewayInterface: + description: The interface for the external VPN gateway. + properties: + id: + description: 'The numeric ID of this interface. The allowed input values + for this id for different redundancy types of external VPN gateway: - + SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY + - 0, 1, 2, 3 ' + format: uint32 + type: integer + ipAddress: + description: IP address of the interface in the external VPN gateway. Only + IPv4 is supported. This IP address can be either from your on-premise + gateway or another Cloud provider's VPN gateway, it cannot be an IP address + from Google Compute Engine. + type: string + type: object + ExternalVpnGatewayList: + description: Response to the list request, and contains a list of externalVpnGateways. + properties: + etag: + type: string + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of ExternalVpnGateway resources. + items: + $ref: '#/components/schemas/ExternalVpnGateway' + type: array + kind: + default: compute#externalVpnGatewayList + description: '[Output Only] Type of resource. Always compute#externalVpnGatewayList + for lists of externalVpnGateways.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + FileContentBuffer: + properties: + content: + description: The raw content in the secure keys file. + format: byte + type: string + fileType: + description: The file type of source file. + enum: + - BIN + - UNDEFINED + - X509 + type: string + type: object + Firewall: + description: Represents a Firewall Rule resource. Firewall rules allow or deny + ingress traffic to, and egress traffic from your instances. For more information, + read Firewall rules. + properties: + allowed: + description: The list of ALLOW rules specified by this firewall. Each rule + specifies a protocol and port-range tuple that describes a permitted connection. + items: + properties: + IPProtocol: + description: The IP protocol to which this rule applies. The protocol + type is required when creating a firewall rule. This value can either + be one of the following well known protocol strings (tcp, udp, icmp, + esp, ah, ipip, sctp) or the IP protocol number. + type: string + ports: + description: 'An optional list of ports to which this rule applies. + This field is only applicable for the UDP or TCP protocol. Each + entry must be either an integer or a range. If not specified, this + rule applies to connections through any port. Example inputs include: + ["22"], ["80","443"], and ["12345-12349"].' + items: + type: string + type: array + type: object + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + denied: + description: The list of DENY rules specified by this firewall. Each rule + specifies a protocol and port-range tuple that describes a denied connection. + items: + properties: + IPProtocol: + description: The IP protocol to which this rule applies. The protocol + type is required when creating a firewall rule. This value can either + be one of the following well known protocol strings (tcp, udp, icmp, + esp, ah, ipip, sctp) or the IP protocol number. + type: string + ports: + description: 'An optional list of ports to which this rule applies. + This field is only applicable for the UDP or TCP protocol. Each + entry must be either an integer or a range. If not specified, this + rule applies to connections through any port. Example inputs include: + ["22"], ["80","443"], and ["12345-12349"].' + items: + type: string + type: array + type: object + type: array + description: + description: An optional description of this resource. Provide this field + when you create the resource. + type: string + destinationRanges: + description: If destination ranges are specified, the firewall rule applies + only to traffic that has destination IP address in these ranges. These + ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported. + items: + type: string + type: array + direction: + description: Direction of traffic to which this firewall applies, either + `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, + you cannot specify the destinationRanges field, and for `EGRESS` traffic, + you cannot specify the sourceRanges or sourceTags fields. + enum: + - EGRESS + - INGRESS + type: string + disabled: + description: Denotes whether the firewall rule is disabled. When set to + true, the firewall rule is not enforced and the network behaves as if + it did not exist. If this is unspecified, the firewall rule will be enabled. + type: boolean + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#firewall + description: '[Output Only] Type of the resource. Always compute#firewall + for firewall rules.' + type: string + logConfig: + $ref: '#/components/schemas/FirewallLogConfig' + description: This field denotes the logging options for a particular firewall + rule. If logging is enabled, logs will be exported to Cloud Logging. + name: + description: 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])?`. The first character must be a + lowercase letter, and all following characters (except for the last character) + must be a dash, lowercase letter, or digit. The last character must be + a lowercase letter or digit. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: 'URL of the network resource for this firewall rule. If not + specified when creating a firewall rule, the default network is used: + global/networks/default If you choose to specify this field, you can specify + the network as a full or partial URL. For example, the following are all + valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network + - projects/myproject/global/networks/my-network - global/networks/default ' + type: string + priority: + description: Priority for this rule. This is an integer between `0` and + `65535`, both inclusive. The default value is `1000`. Relative priorities + determine which rule takes effect if multiple rules apply. Lower values + indicate higher priority. For example, a rule with priority `0` has higher + precedence than a rule with priority `1`. DENY rules take precedence over + ALLOW rules if they have equal priority. Note that VPC networks have implied + rules with a priority of `65535`. To avoid conflicts with the implied + rules, use a priority number less than `65535`. + format: int32 + type: integer + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sourceRanges: + description: If source ranges are specified, the firewall rule applies only + to traffic that has a source IP address in these ranges. These ranges + must be expressed in CIDR format. One or both of sourceRanges and sourceTags + may be set. If both fields are set, the rule applies to traffic that has + a source IP address within sourceRanges OR a source IP from a resource + with a matching tag listed in the sourceTags field. The connection does + not need to match both fields for the rule to apply. Both IPv4 and IPv6 + are supported. + items: + type: string + type: array + sourceServiceAccounts: + description: If source service accounts are specified, the firewall rules + apply only to traffic originating from an instance with a service account + in this list. Source service accounts cannot be used to control traffic + to an instance's external IP address because service accounts are associated + with an instance, not an IP address. sourceRanges can be set at the same + time as sourceServiceAccounts. If both are set, the firewall applies to + traffic that has a source IP address within the sourceRanges OR a source + IP that belongs to an instance with service account listed in sourceServiceAccount. + The connection does not need to match both fields for the firewall to + apply. sourceServiceAccounts cannot be used at the same time as sourceTags + or targetTags. + items: + type: string + type: array + sourceTags: + description: If source tags are specified, the firewall rule applies only + to traffic with source IPs that match the primary network interfaces of + VM instances that have the tag and are in the same VPC network. Source + tags cannot be used to control traffic to an instance's external IP address, + it only applies to traffic between instances in the same virtual network. + Because tags are associated with instances, not IP addresses. One or both + of sourceRanges and sourceTags may be set. If both fields are set, the + firewall applies to traffic that has a source IP address within sourceRanges + OR a source IP from a resource with a matching tag listed in the sourceTags + field. The connection does not need to match both fields for the firewall + to apply. + items: + type: string + type: array + targetServiceAccounts: + description: A list of service accounts indicating sets of instances located + in the network that may make network connections as specified in allowed[]. + targetServiceAccounts cannot be used at the same time as targetTags or + sourceTags. If neither targetServiceAccounts nor targetTags are specified, + the firewall rule applies to all instances on the specified network. + items: + type: string + type: array + targetTags: + description: A list of tags that controls which instances the firewall rule + applies to. If targetTags are specified, then the firewall rule applies + only to instances in the VPC network that have one of those tags. If no + targetTags are specified, the firewall rule applies to all instances on + the specified network. + items: + type: string + type: array + type: object + FirewallList: + description: Contains a list of firewalls. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Firewall resources. + items: + $ref: '#/components/schemas/Firewall' + type: array + kind: + default: compute#firewallList + description: '[Output Only] Type of resource. Always compute#firewallList + for lists of firewalls.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + FirewallLogConfig: + description: The available logging options for a firewall rule. + properties: + enable: + description: This field denotes whether to enable logging for a particular + firewall rule. + type: boolean + metadata: + description: This field can only be specified for a particular firewall + rule if logging is enabled for that rule. This field denotes whether to + include or exclude metadata for firewall logs. + enum: + - EXCLUDE_ALL_METADATA + - INCLUDE_ALL_METADATA + type: string + type: object + FirewallPoliciesListAssociationsResponse: + properties: + associations: + description: A list of associations. + items: + $ref: '#/components/schemas/FirewallPolicyAssociation' + type: array + kind: + default: compute#firewallPoliciesListAssociationsResponse + description: '[Output Only] Type of firewallPolicy associations. Always + compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations.' + type: string + type: object + FirewallPolicy: + description: Represents a Firewall Policy resource. + properties: + associations: + description: A list of associations that belong to this firewall policy. + items: + $ref: '#/components/schemas/FirewallPolicyAssociation' + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + displayName: + 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 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 + fingerprint: + description: Specifies a fingerprint for this resource, which is essentially + a hash of the metadata's contents and used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update metadata. You must always provide an + up-to-date fingerprint hash in order to update or change metadata, otherwise + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make get() request to the firewall policy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#firewallPolicy + description: '[Output only] Type of the resource. Always compute#firewallPolicyfor + firewall policies' + type: string + name: + description: '[Output Only] Name of the resource. It is a numeric ID allocated + by GCP which uniquely identifies the Firewall Policy.' + type: string + parent: + description: '[Output Only] The parent of the firewall policy.' + type: string + ruleTupleCount: + description: '[Output Only] Total count of all firewall policy rule tuples. + A firewall policy can not exceed a set number of tuples.' + format: int32 + type: integer + rules: + description: A list of rules that belong to this policy. There must always + be a default rule (rule with priority 2147483647 and match "*"). If no + rules are provided when creating a firewall policy, a default rule with + action "allow" will be added. + items: + $ref: '#/components/schemas/FirewallPolicyRule' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + selfLinkWithId: + description: '[Output Only] Server-defined URL for this resource with the + resource id.' + type: string + shortName: + description: User-provided name of the Organization firewall plicy. The + name should be unique in the organization in which the firewall policy + is created. 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 + type: object + FirewallPolicyAssociation: + properties: + attachmentTarget: + description: The target that the firewall policy is attached to. + type: string + displayName: + description: '[Output Only] Deprecated, please use short name instead. The + display name of the firewall policy of the association.' + type: string + firewallPolicyId: + description: '[Output Only] The firewall policy ID of the association.' + type: string + name: + description: The name for an association. + type: string + shortName: + description: '[Output Only] The short name of the firewall policy of the + association.' + type: string + type: object + FirewallPolicyList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of FirewallPolicy resources. + items: + $ref: '#/components/schemas/FirewallPolicy' + type: array + kind: + default: compute#firewallPolicyList + description: '[Output Only] Type of resource. Always compute#firewallPolicyList + for listsof FirewallPolicies' + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + FirewallPolicyRule: + description: Represents a rule that describes one or more match conditions along + with the action to be taken when traffic matches this condition (allow or + deny). + properties: + action: + description: The Action to perform when the client connection triggers the + rule. Can currently be either "allow" or "deny()" where valid values for + status are 403, 404, and 502. + type: string + description: + description: An optional description for this resource. + type: string + direction: + description: The direction in which this rule applies. + enum: + - EGRESS + - INGRESS + type: string + disabled: + description: Denotes whether the firewall policy rule is disabled. When + set to true, the firewall policy rule is not enforced and traffic behaves + as if it did not exist. If this is unspecified, the firewall policy rule + will be enabled. + type: boolean + enableLogging: + description: 'Denotes whether to enable logging for a particular rule. If + logging is enabled, logs will be exported to the configured export destination + in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you + cannot enable logging on "goto_next" rules.' + type: boolean + kind: + default: compute#firewallPolicyRule + description: '[Output only] Type of the resource. Always compute#firewallPolicyRule + for firewall policy rules' + type: string + match: + $ref: '#/components/schemas/FirewallPolicyRuleMatcher' + description: A match condition that incoming traffic is evaluated against. + If it evaluates to true, the corresponding 'action' is enforced. + priority: + description: An integer indicating the priority of a rule in the list. The + priority must be a positive value between 0 and 2147483647. Rules are + evaluated from highest to lowest priority where 0 is the highest priority + and 2147483647 is the lowest prority. + format: int32 + type: integer + ruleTupleCount: + description: '[Output Only] Calculation of the complexity of a single firewall + policy rule.' + format: int32 + type: integer + targetResources: + description: A list of network resource URLs to which this rule applies. + This field allows you to control which network's VMs get this rule. If + this field is left blank, all VMs within the organization will receive + the rule. + items: + type: string + type: array + targetServiceAccounts: + description: A list of service accounts indicating the sets of instances + that are applied with this rule. + items: + type: string + type: array + type: object + FirewallPolicyRuleMatcher: + description: Represents a match condition that incoming traffic is evaluated + against. Exactly one field must be specified. + properties: + destIpRanges: + description: CIDR IP address range. Maximum number of destination CIDR IP + ranges allowed is 5000. + items: + type: string + type: array + layer4Configs: + description: Pairs of IP protocols and ports that the rule should match. + items: + $ref: '#/components/schemas/FirewallPolicyRuleMatcherLayer4Config' + type: array + srcIpRanges: + description: CIDR IP address range. Maximum number of source CIDR IP ranges + allowed is 5000. + items: + type: string + type: array + type: object + FirewallPolicyRuleMatcherLayer4Config: + properties: + ipProtocol: + description: The IP protocol to which this rule applies. The protocol type + is required when creating a firewall rule. This value can either be one + of the following well known protocol strings (tcp, udp, icmp, esp, ah, + ipip, sctp), or the IP protocol number. + type: string + ports: + description: 'An optional list of ports to which this rule applies. This + field is only applicable for UDP or TCP protocol. Each entry must be either + an integer or a range. If not specified, this rule applies to connections + through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' + items: + type: string + type: array + type: object + FixedOrPercent: + description: Encapsulates numeric value that can be either absolute or relative. + properties: + calculated: + description: '[Output Only] Absolute value of VM instances calculated based + on the specific mode. - If the value is fixed, then the calculated value + is equal to the fixed value. - If the value is a percent, then the calculated + value is percent/100 * targetSize. For example, the calculated value of + a 80% of a managed instance group with 150 instances would be (80/100 + * 150) = 120 VM instances. If there is a remainder, the number is rounded. ' + format: int32 + type: integer + fixed: + description: Specifies a fixed number of VM instances. This must be a positive + integer. + format: int32 + type: integer + percent: + description: Specifies a percentage of instances between 0 to 100%, inclusive. + For example, specify 80 for 80%. + format: int32 + type: integer + type: object + ForwardingRule: + description: 'Represents a Forwarding Rule resource. Forwarding rule resources + in Google Cloud can be either regional or global in scope: * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules) + * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules) + A forwarding rule and its corresponding IP address represent the frontend + configuration of a Google Cloud Platform load balancer. Forwarding rules can + also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). + For more information, read Forwarding rule concepts and Using protocol forwarding.' + properties: + IPAddress: + description: 'IP address that this forwarding rule serves. When a client + sends traffic to this IP address, the forwarding rule directs the traffic + to the target that you specify in the forwarding rule. If you don''t specify + a reserved IP address, an ephemeral IP address is assigned. Methods for + specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full + URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region + /addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name + - regions/region/addresses/address-name - global/addresses/address-name + - address-name The loadBalancingScheme and the forwarding rule''s target + determine the type of IP address that you can use. For detailed information, + see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). + Must be set to `0.0.0.0` when the target is targetGrpcProxy that has validateForProxyless + field set to true. For Private Service Connect forwarding rules that forward + traffic to Google APIs, IP address must be provided.' + type: string + IPProtocol: + description: The IP protocol to which this rule applies. For protocol forwarding, + valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid + IP protocols are different for different load balancing products as described + in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). + enum: + - AH + - ESP + - ICMP + - SCTP + - TCP + - UDP + type: string + allPorts: + description: This field is used along with the backend_service field for + Internal TCP/UDP Load Balancing or Network Load Balancing, or with the + target field for internal and external TargetInstance. You can only use + one of ports and port_range, or allPorts. The three are mutually exclusive. + For TCP, UDP and SCTP traffic, packets addressed to any ports will be + forwarded to the target or backendService. + type: boolean + allowGlobalAccess: + description: This field is used along with the backend_service field for + internal load balancing or with the target field for internal TargetInstance. + If the field is set to TRUE, clients can access ILB from all regions. + Otherwise only allows access from clients in the same region as the internal + load balancer. + type: boolean + backendService: + description: Identifies the backend service to which the forwarding rule + sends traffic. Required for Internal TCP/UDP Load Balancing and Network + Load Balancing; must be omitted for all other load balancer types. + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a ForwardingRule. Include the fingerprint in + patch request to ensure that you do not overwrite changes that were applied + from another concurrent request. To see the latest fingerprint, make a + get() request to retrieve a ForwardingRule. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + ipVersion: + description: The IP Version that will be used by this forwarding rule. Valid + options are IPV4 or IPV6. This can only be specified for an external global + forwarding rule. + enum: + - IPV4 + - IPV6 + - UNSPECIFIED_VERSION + type: string + isMirroringCollector: + description: Indicates whether or not this load balancer can be used as + a collector for packet mirroring. To prevent mirroring loops, instances + behind this load balancer will not have their traffic mirrored even if + a PacketMirroring rule applies to them. This can only be set to true for + load balancers that have their loadBalancingScheme set to INTERNAL. + type: boolean + kind: + default: compute#forwardingRule + description: '[Output Only] Type of the resource. Always compute#forwardingRule + for Forwarding Rule resources.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this resource, + which is essentially a hash of the labels set used for optimistic locking. + The fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve a ForwardingRule. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels for this resource. These can only be added or modified + by the setLabels method. Each label key/value pair must comply with RFC1035. + Label values may be empty. + type: object + loadBalancingScheme: + description: Specifies the forwarding rule type. For more information about + forwarding rules, refer to Forwarding rule concepts. + enum: + - EXTERNAL + - INTERNAL + - INTERNAL_MANAGED + - INTERNAL_SELF_MANAGED + - INVALID + type: string + metadataFilters: + description: Opaque filter criteria used by load balancer to restrict routing + configuration to a limited set of xDS compliant clients. In their xDS + requests to load balancer, xDS clients present node metadata. When there + is a match, the relevant configuration is made available to those proxies. + Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced + by the ForwardingRule are not visible to those proxies. For each metadataFilter + in this list, if its filterMatchCriteria is set to MATCH_ANY, at least + one of the filterLabels must match the corresponding label provided in + the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all + of its filterLabels must match with corresponding labels provided in the + metadata. If multiple metadataFilters are specified, all of them need + to be satisfied in order to be considered a match. metadataFilters specified + here will be applifed before those specified in the UrlMap that this ForwardingRule + references. metadataFilters only applies to Loadbalancers that have their + loadBalancingScheme set to INTERNAL_SELF_MANAGED. + items: + $ref: '#/components/schemas/MetadataFilter' + type: array + name: + description: 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. For Private Service Connect forwarding rules that forward traffic + to Google APIs, the forwarding rule name must be a 1-20 characters string + with lowercase letters and numbers and must start with a letter. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: This field is not used for external load balancing. For Internal + TCP/UDP Load Balancing, this field identifies the network that the load + balanced IP should belong to for this Forwarding Rule. If this field is + not specified, the default network will be used. For Private Service Connect + forwarding rules that forward traffic to Google APIs, a network must be + provided. + type: string + networkTier: + description: 'This signifies the networking tier used for configuring this + load balancer and can only take the following values: PREMIUM, STANDARD. + For regional ForwardingRule, the valid values are PREMIUM and STANDARD. + For GlobalForwardingRule, the valid value is PREMIUM. If this field is + not specified, it is assumed to be PREMIUM. If IPAddress is specified, + this value must be equal to the networkTier of the Address.' + enum: + - PREMIUM + - STANDARD + type: string + portRange: + description: 'This field can be used only if: - Load balancing scheme is + one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol + is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified + range will be forwarded to target or backend_service. You can only use + one of ports, port_range, or allPorts. The three are mutually exclusive. + Forwarding rules with the same [IPAddress, IPProtocol] pair must have + disjoint ports. Some types of forwarding target have constraints on the + acceptable ports. For more information, see [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications). + @pattern: \\d+(?:-\\d+)?' + type: string + ports: + description: 'The ports field is only supported when the forwarding rule + references a backend_service directly. Only packets addressed to the [specified + list of ports]((https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications)) + are forwarded to backends. You can only use one of ports and port_range, + or allPorts. The three are mutually exclusive. You can specify a list + of up to five ports, which can be non-contiguous. Forwarding rules with + the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: + \\d+(?:-\\d+)?' + items: + type: string + type: array + pscConnectionId: + description: '[Output Only] The PSC connection id of the PSC Forwarding + Rule.' + format: uint64 + type: string + pscConnectionStatus: + enum: + - ACCEPTED + - CLOSED + - PENDING + - REJECTED + - STATUS_UNSPECIFIED + type: string + region: + description: '[Output Only] URL of the region where the regional forwarding + rule resides. This field is not applicable to global forwarding rules. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + serviceDirectoryRegistrations: + description: Service Directory resources to register this forwarding rule + with. Currently, only supports a single Service Directory resource. It + is only supported for internal load balancing. + items: + $ref: '#/components/schemas/ForwardingRuleServiceDirectoryRegistration' + type: array + serviceLabel: + description: An optional prefix to the service name for this Forwarding + Rule. If specified, the prefix is the first label of the fully qualified + service name. The label must be 1-63 characters long, and comply with + RFC1035. Specifically, the label 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. This field is only used for internal load balancing. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + serviceName: + description: '[Output Only] The internal fully qualified service name for + this Forwarding Rule. This field is only used for internal load balancing.' + type: string + subnetwork: + description: This field identifies the subnetwork that the load balanced + IP should belong to for this Forwarding Rule, used in internal load balancing + and network load balancing with IPv6. If the network specified is in auto + subnet mode, this field is optional. However, a subnetwork must be specified + if the network is in custom subnet mode or when creating external forwarding + rule with IPv6. + type: string + target: + type: string + type: object + ForwardingRuleAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/ForwardingRulesScopedList' + description: Name of the scope containing this set of addresses. + description: A list of ForwardingRulesScopedList resources. + type: object + kind: + default: compute#forwardingRuleAggregatedList + description: '[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList + for lists of forwarding rules.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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. + 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: '#/components/schemas/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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ForwardingRuleReference: + properties: + forwardingRule: + type: string + type: object + ForwardingRuleServiceDirectoryRegistration: + description: Describes the auto-registration of the Forwarding Rule to Service + Directory. The region and project of the Service Directory resource generated + from this registration will be the same as this Forwarding Rule. + properties: + namespace: + description: Service Directory namespace to register the forwarding rule + under. + type: string + service: + description: Service Directory service to register the forwarding rule under. + type: string + serviceDirectoryRegion: + description: '[Optional] Service Directory region to register this global + forwarding rule under. Default to "us-central1". Only used for PSC for + Google APIs. All PSC for Google APIs Forwarding Rules on the same network + should use the same Service Directory region.' + type: string + type: object + ForwardingRulesScopedList: + properties: + forwardingRules: + description: A list of forwarding rules contained in this scope. + items: + $ref: '#/components/schemas/ForwardingRule' + type: array + warning: + description: Informational warning which replaces the list of forwarding + rules 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + GRPCHealthCheck: + properties: + grpcServiceName: + description: 'The gRPC service name for the health check. This field is + optional. The value of grpc_service_name has the following meanings by + convention: - Empty service_name means the overall status of all services + at the backend. - Non-empty service_name means the health of that gRPC + service, as defined by the owner of the service. The grpc_service_name + can only be ASCII.' + type: string + port: + description: The port number for the health check request. Must be specified + if port_name and port_specification are not set or if port_specification + is USE_FIXED_PORT. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. The port_name should + conform to RFC1035. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, gRPC health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + type: object + GlobalNetworkEndpointGroupsAttachEndpointsRequest: + properties: + networkEndpoints: + description: The list of network endpoints to be attached. + items: + $ref: '#/components/schemas/NetworkEndpoint' + type: array + type: object + GlobalNetworkEndpointGroupsDetachEndpointsRequest: + properties: + networkEndpoints: + description: The list of network endpoints to be detached. + items: + $ref: '#/components/schemas/NetworkEndpoint' + type: array + type: object + GlobalOrganizationSetPolicyRequest: + properties: + bindings: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + format: byte + type: string + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the ''resource''. + The size of the policy is limited to a few 10s of KB. An empty policy + is in general a valid policy but certain services (like Projects) might + reject them.' + type: object + GlobalSetLabelsRequest: + properties: + labelFingerprint: + description: The fingerprint of the previous set of labels for this resource, + used to detect conflicts. The fingerprint is initially generated by Compute + Engine and changes after every request to modify or update labels. You + must always provide an up-to-date fingerprint hash when updating or changing + labels, otherwise the request will fail with error 412 conditionNotMet. + Make a get() request to the resource to get the latest fingerprint. + format: byte + type: string + labels: + additionalProperties: + type: string + description: 'A list of labels to apply for this resource. Each label key + & value must 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. For example, "webserver-frontend": + "images". A label value can also be empty (e.g. "my-label": "").' + type: object + type: object + GlobalSetPolicyRequest: + properties: + bindings: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + format: byte + type: string + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the ''resource''. + The size of the policy is limited to a few 10s of KB. An empty policy + is in general a valid policy but certain services (like Projects) might + reject them.' + type: object + GuestAttributes: + description: A guest attributes entry. + properties: + kind: + default: compute#guestAttributes + description: '[Output Only] Type of the resource. Always compute#guestAttributes + for guest attributes entry.' + type: string + queryPath: + description: The path to be queried. This can be the default namespace ('') + or a nested namespace ('\/') or a specified key ('\/\'). + type: string + queryValue: + $ref: '#/components/schemas/GuestAttributesValue' + description: '[Output Only] The value of the requested queried path.' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + variableKey: + description: The key to search for. + type: string + variableValue: + description: '[Output Only] The value found for the requested key.' + type: string + type: object + GuestAttributesEntry: + description: A guest attributes namespace/key/value entry. + properties: + key: + description: Key for the guest attribute entry. + type: string + namespace: + description: Namespace for the guest attribute entry. + type: string + value: + description: Value for the guest attribute entry. + type: string + type: object + GuestAttributesValue: + description: Array of guest attribute namespace/key/value tuples. + properties: + items: + items: + $ref: '#/components/schemas/GuestAttributesEntry' + type: array + type: object + GuestOsFeature: + description: Guest OS features. + properties: + type: + description: The ID of a supported feature. Read Enabling guest operating + system features to see a list of available options. + enum: + - FEATURE_TYPE_UNSPECIFIED + - GVNIC + - MULTI_IP_SUBNET + - SECURE_BOOT + - SEV_CAPABLE + - UEFI_COMPATIBLE + - VIRTIO_SCSI_MULTIQUEUE + - WINDOWS + type: string + type: object + HTTP2HealthCheck: + properties: + host: + description: The value of the host header in the HTTP/2 health check request. + If left empty (default value), the IP on behalf of which this health check + is performed will be used. + type: string + port: + description: The TCP port number for the health check request. The default + value is 443. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, HTTP2 health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + requestPath: + description: The request path of the HTTP/2 health check request. The default + value is /. + type: string + response: + description: The string to match anywhere in the first 1024 bytes of the + response body. If left empty (the default value), the status code determines + health. The response data can only be ASCII. + type: string + type: object + HTTPHealthCheck: + properties: + host: + description: The value of the host header in the HTTP health check request. + If left empty (default value), the IP on behalf of which this health check + is performed will be used. + type: string + port: + description: The TCP port number for the health check request. The default + value is 80. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, HTTP health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + requestPath: + description: The request path of the HTTP health check request. The default + value is /. + type: string + response: + description: The string to match anywhere in the first 1024 bytes of the + response body. If left empty (the default value), the status code determines + health. The response data can only be ASCII. + type: string + type: object + HTTPSHealthCheck: + properties: + host: + description: The value of the host header in the HTTPS health check request. + If left empty (default value), the IP on behalf of which this health check + is performed will be used. + type: string + port: + description: The TCP port number for the health check request. The default + value is 443. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, HTTPS health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + requestPath: + description: The request path of the HTTPS health check request. The default + value is /. + type: string + response: + description: The string to match anywhere in the first 1024 bytes of the + response body. If left empty (the default value), the status code determines + health. The response data can only be ASCII. + type: string + type: object + HealthCheck: + description: 'Represents a Health Check resource. Google Compute Engine has + two Health Check resources: * [Global](/compute/docs/reference/rest/v1/healthChecks) + * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) Internal + HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). + Traffic Director must use global health checks (`compute.v1.HealthChecks`). + Internal TCP/UDP load balancers can use either regional or global health checks + (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). External HTTP(S), + TCP proxy, and SSL proxy load balancers as well as managed instance group + auto-healing must use global health checks (`compute.v1.HealthChecks`). Backend + service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). + Target pool-based network load balancers must use legacy HTTP health checks + (`compute.v1.httpHealthChecks`). For more information, see Health checks overview.' + properties: + checkIntervalSec: + description: How often (in seconds) to send a health check. The default + value is 5 seconds. + format: int32 + type: integer + creationTimestamp: + description: '[Output Only] Creation timestamp in 3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + grpcHealthCheck: + $ref: '#/components/schemas/GRPCHealthCheck' + healthyThreshold: + description: A so-far unhealthy instance will be marked healthy after this + many consecutive successes. The default value is 2. + format: int32 + type: integer + http2HealthCheck: + $ref: '#/components/schemas/HTTP2HealthCheck' + httpHealthCheck: + $ref: '#/components/schemas/HTTPHealthCheck' + httpsHealthCheck: + $ref: '#/components/schemas/HTTPSHealthCheck' + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#healthCheck + description: Type of the resource. + type: string + logConfig: + $ref: '#/components/schemas/HealthCheckLogConfig' + description: Configure logging on this health check. + name: + description: 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. + For example, a name that is 1-63 characters long, matches the regular + expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. + This regular expression describes a name where the first character is + a lowercase letter, and all following characters are a dash, lowercase + letter, or digit, except the last character, which isn't a dash. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + region: + description: '[Output Only] Region where the health check resides. Not applicable + to global health checks.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sslHealthCheck: + $ref: '#/components/schemas/SSLHealthCheck' + tcpHealthCheck: + $ref: '#/components/schemas/TCPHealthCheck' + timeoutSec: + description: How long (in seconds) to wait before claiming failure. The + default value is 5 seconds. It is invalid for timeoutSec to have greater + value than checkIntervalSec. + format: int32 + type: integer + type: + description: Specifies the type of the healthCheck, either TCP, SSL, HTTP, + HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the + protocol-specific health check field must be specified, which must match + type field. + enum: + - GRPC + - HTTP + - HTTP2 + - HTTPS + - INVALID + - SSL + - TCP + type: string + unhealthyThreshold: + description: A so-far healthy instance will be marked unhealthy after this + many consecutive failures. The default value is 2. + format: int32 + type: integer + type: object + HealthCheckList: + description: Contains a list of HealthCheck resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of HealthCheck resources. + items: + $ref: '#/components/schemas/HealthCheck' + type: array + kind: + default: compute#healthCheckList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HealthCheckLogConfig: + description: Configuration of logging on a health check. If logging is enabled, + logs will be exported to Stackdriver. + properties: + enable: + description: Indicates whether or not to export logs. This is false by default, + which means no health check logging will be done. + type: boolean + type: object + HealthCheckReference: + description: '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 ' + properties: + healthCheck: + type: string + type: object + HealthCheckService: + description: Represents a Health-Check as a Service resource. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a HealthCheckService. An up-to-date fingerprint + must be provided in order to patch/update the HealthCheckService; Otherwise, + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the HealthCheckService. + format: byte + type: string + healthChecks: + description: A list of URLs to the HealthCheck resources. Must have at least + one HealthCheck, and not more than 10. HealthCheck resources must have + portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. + For regional HealthCheckService, the HealthCheck must be regional and + in the same region. For global HealthCheckService, HealthCheck must be + global. Mix of regional and global HealthChecks is not supported. Multiple + regional HealthChecks must belong to the same region. Regional HealthChecks + must belong to the same region as zones of NEGs. + items: + type: string + type: array + healthStatusAggregationPolicy: + description: Optional. Policy for how the results from multiple health checks + for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. + - NO_AGGREGATION. An EndpointHealth message is returned for each pair + in the health check service. - AND. If any health check of an endpoint + reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. + If all health checks report HEALTHY, the HealthState of the endpoint is + HEALTHY. . + enum: + - AND + - NO_AGGREGATION + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#healthCheckService + description: '[Output only] Type of the resource. Always compute#healthCheckServicefor + health check services.' + type: string + name: + description: Name of the resource. 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 + networkEndpointGroups: + description: A list of URLs to the NetworkEndpointGroup resources. Must + not have more than 100. For regional HealthCheckService, NEGs must be + in zones in the region of the HealthCheckService. + items: + type: string + type: array + notificationEndpoints: + description: A list of URLs to the NotificationEndpoint resources. Must + not have more than 10. A list of endpoints for receiving notifications + of change in health status. For regional HealthCheckService, NotificationEndpoint + must be regional and in the same region. For global HealthCheckService, + NotificationEndpoint must be global. + items: + type: string + type: array + region: + description: '[Output Only] URL of the region where the health check service + resides. This field is not applicable to global health check services. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + HealthCheckServiceReference: + description: '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 ' + properties: + healthCheckService: + type: string + type: object + HealthCheckServicesList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of HealthCheckService resources. + items: + $ref: '#/components/schemas/HealthCheckService' + type: array + kind: + default: compute#healthCheckServicesList + description: '[Output Only] Type of the resource. Always compute#healthCheckServicesList + for lists of HealthCheckServices.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HealthChecksAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/HealthChecksScopedList' + description: Name of the scope containing this set of HealthChecks. + description: A list of HealthChecksScopedList resources. + type: object + kind: + default: compute#healthChecksAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HealthChecksScopedList: + properties: + healthChecks: + description: A list of HealthChecks contained in this scope. + items: + $ref: '#/components/schemas/HealthCheck' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HealthStatus: + properties: + annotations: + additionalProperties: + type: string + description: Metadata defined as annotations for network endpoint. + type: object + forwardingRule: + description: URL of the forwarding rule associated with the health status + of the instance. + type: string + forwardingRuleIp: + description: A forwarding rule IP address assigned to this instance. + type: string + healthState: + description: Health state of the instance. + enum: + - HEALTHY + - UNHEALTHY + type: string + instance: + description: URL of the instance resource. + type: string + ipAddress: + description: For target pool based Network Load Balancing, it indicates + the forwarding rule's IP address assigned to this instance. For other + types of load balancing, the field indicates VM internal ip. + type: string + port: + description: The named port of the instance group, not necessarily the port + that is health-checked. + format: int32 + type: integer + weight: + type: string + weightError: + enum: + - INVALID_WEIGHT + - MISSING_WEIGHT + - UNAVAILABLE_WEIGHT + - WEIGHT_NONE + type: string + type: object + HealthStatusForNetworkEndpoint: + properties: + backendService: + $ref: '#/components/schemas/BackendServiceReference' + description: URL of the backend service associated with the health state + of the network endpoint. + forwardingRule: + $ref: '#/components/schemas/ForwardingRuleReference' + description: URL of the forwarding rule associated with the health state + of the network endpoint. + healthCheck: + $ref: '#/components/schemas/HealthCheckReference' + description: URL of the health check associated with the health state of + the network endpoint. + healthCheckService: + $ref: '#/components/schemas/HealthCheckServiceReference' + description: URL of the health check service associated with the health + state of the network endpoint. + healthState: + description: Health state of the network endpoint determined based on the + health checks configured. + enum: + - DRAINING + - HEALTHY + - UNHEALTHY + - UNKNOWN + type: string + type: object + HostRule: + description: UrlMaps A host-matching rule for a URL. If matched, will use the + named PathMatcher to select the BackendService. + properties: + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + hosts: + description: The list of host patterns to match. They must be valid hostnames + with optional port numbers in the format host:port. * matches any string + of ([a-z0-9-.]*). In that case, * must be the first character and must + be followed in the pattern by either - or .. * based matching is not supported + when the URL map is bound to target gRPC proxy that has validateForProxyless + field set to true. + items: + type: string + type: array + pathMatcher: + description: The name of the PathMatcher to use to match the path portion + of the URL if the hostRule matches the URL's host portion. + type: string + type: object + HttpFaultAbort: + description: Specification for how requests are aborted as part of fault injection. + properties: + httpStatus: + description: The HTTP status code used to abort the request. The value must + be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code + is mapped to HTTP status code according to this mapping table. HTTP status + 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently + not supported by Traffic Director. + format: uint32 + type: integer + percentage: + description: The percentage of traffic (connections/operations/requests) + which will be aborted as part of fault injection. The value must be between + 0.0 and 100.0 inclusive. + format: double + type: number + type: object + HttpFaultDelay: + description: Specifies the delay introduced by Loadbalancer before forwarding + the request to the backend service as part of fault injection. + properties: + fixedDelay: + $ref: '#/components/schemas/Duration' + description: Specifies the value of the fixed delay interval. + percentage: + description: The percentage of traffic (connections/operations/requests) + on which delay will be introduced as part of fault injection. The value + must be between 0.0 and 100.0 inclusive. + format: double + type: number + type: object + HttpFaultInjection: + description: The specification for fault injection introduced into traffic to + test the resiliency of clients to backend service failure. As part of fault + injection, when clients send requests to a backend service, delays can be + introduced by Loadbalancer on a percentage of requests before sending those + request to the backend service. Similarly requests from clients can be aborted + by the Loadbalancer for a percentage of requests. + properties: + abort: + $ref: '#/components/schemas/HttpFaultAbort' + description: The specification for how client requests are aborted as part + of fault injection. + delay: + $ref: '#/components/schemas/HttpFaultDelay' + description: The specification for how client requests are delayed as part + of fault injection, before being sent to a backend service. + type: object + HttpHeaderAction: + description: The request and response header transformations that take effect + before the request is passed along to the selected backendService. + properties: + requestHeadersToAdd: + description: Headers to add to a matching request prior to forwarding the + request to the backendService. + items: + $ref: '#/components/schemas/HttpHeaderOption' + type: array + requestHeadersToRemove: + description: A list of header names for headers that need to be removed + from the request prior to forwarding the request to the backendService. + items: + type: string + type: array + responseHeadersToAdd: + description: Headers to add the response prior to sending the response back + to the client. + items: + $ref: '#/components/schemas/HttpHeaderOption' + type: array + responseHeadersToRemove: + description: A list of header names for headers that need to be removed + from the response prior to sending the response back to the client. + items: + type: string + type: array + type: object + HttpHeaderMatch: + description: matchRule criteria for request header matches. + properties: + exactMatch: + description: The value should exactly match contents of exactMatch. Only + one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch + or rangeMatch must be set. + type: string + headerName: + description: 'The name of the HTTP header to match. For matching against + the HTTP request''s authority, use a headerMatch with the header name + ":authority". For matching a request''s method, use the headerName ":method". + When the URL map is bound to target gRPC proxy that has validateForProxyless + field set to true, only non-binary user-specified custom metadata and + the `content-type` header are supported. The following transport-level + headers cannot be used in header matching rules: `:authority`, `:method`, + `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, + `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, + `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.' + type: string + invertMatch: + description: If set to false, the headerMatch is considered a match if the + match criteria above are met. If set to true, the headerMatch is considered + a match if the match criteria above are NOT met. The default setting is + false. + type: boolean + prefixMatch: + description: The value of the header must start with the contents of prefixMatch. + Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch + or rangeMatch must be set. + type: string + presentMatch: + description: A header with the contents of headerName must exist. The match + takes place whether or not the request's header has a value. Only one + of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch + must be set. + type: boolean + rangeMatch: + $ref: '#/components/schemas/Int64RangeMatch' + description: The header value must be an integer and its value must be in + the range specified in rangeMatch. If the header does not contain an integer, + number or is empty, the match fails. For example for a range [-5, 0] - + -3 will match. - 0 will not match. - 0.25 will not match. - -3someString + will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, + presentMatch or rangeMatch must be set. Note that rangeMatch is not supported + for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. + regexMatch: + description: 'The value of the header must match the regular expression + specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax + For matching against a port specified in the HTTP request, use a headerMatch + with headerName set to PORT and a regular expression that satisfies the + RFC2616 Host header''s port specifier. Only one of exactMatch, prefixMatch, + suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note + that regexMatch only applies to Loadbalancers that have their loadBalancingScheme + set to INTERNAL_SELF_MANAGED.' + type: string + suffixMatch: + description: The value of the header must end with the contents of suffixMatch. + Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch + or rangeMatch must be set. + type: string + type: object + HttpHeaderOption: + description: Specification determining how headers are added to requests or + responses. + properties: + headerName: + description: The name of the header. + type: string + headerValue: + description: The value of the header to add. + type: string + replace: + description: If false, headerValue is appended to any values that already + exist for the header. If true, headerValue is set for the header, discarding + any values that were set for that header. The default value is false. + type: boolean + type: object + HttpHealthCheck: + description: Represents a legacy HTTP Health Check resource. Legacy HTTP health + checks are now only required by target pool-based network load balancers. + For all other load balancers, including backend service-based network load + balancers, and for managed instance group auto-healing, you must use modern + (non-legacy) health checks. For more information, see Health checks overview + . + properties: + checkIntervalSec: + description: How often (in seconds) to send a health check. The default + value is 5 seconds. + format: int32 + type: integer + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + healthyThreshold: + description: A so-far unhealthy instance will be marked healthy after this + many consecutive successes. The default value is 2. + format: int32 + type: integer + host: + description: The value of the host header in the HTTP health check request. + If left empty (default value), the public IP on behalf of which this health + check is performed will be used. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#httpHealthCheck + description: '[Output Only] Type of the resource. Always compute#httpHealthCheck + for HTTP health checks.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + port: + description: The TCP port number for the HTTP health check request. The + default value is 80. + format: int32 + type: integer + requestPath: + description: The request path of the HTTP health check request. The default + value is /. This field does not support query parameters. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + timeoutSec: + description: How long (in seconds) to wait before claiming failure. The + default value is 5 seconds. It is invalid for timeoutSec to have greater + value than checkIntervalSec. + format: int32 + type: integer + unhealthyThreshold: + description: A so-far healthy instance will be marked unhealthy after this + many consecutive failures. The default value is 2. + format: int32 + type: integer + type: object + HttpHealthCheckList: + description: Contains a list of HttpHealthCheck resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of HttpHealthCheck resources. + items: + $ref: '#/components/schemas/HttpHealthCheck' + type: array + kind: + default: compute#httpHealthCheckList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HttpQueryParameterMatch: + description: HttpRouteRuleMatch criteria for a request's query parameter. + properties: + exactMatch: + description: The queryParameterMatch matches if the value of the parameter + exactly matches the contents of exactMatch. Only one of presentMatch, + exactMatch or regexMatch must be set. + type: string + name: + description: The name of the query parameter to match. The query parameter + must exist in the request, in the absence of which the request match fails. + type: string + presentMatch: + description: Specifies that the queryParameterMatch matches if the request + contains the query parameter, irrespective of whether the parameter has + a value or not. Only one of presentMatch, exactMatch or regexMatch must + be set. + type: boolean + regexMatch: + description: The queryParameterMatch matches if the value of the parameter + matches the regular expression specified by regexMatch. For the regular + expression grammar, please see github.com/google/re2/wiki/Syntax Only + one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch + only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. + type: string + type: object + HttpRedirectAction: + description: Specifies settings for an HTTP redirect. + properties: + hostRedirect: + description: The host that will be used in the redirect response instead + of the one that was supplied in the request. The value must be between + 1 and 255 characters. + type: string + httpsRedirect: + description: If set to true, the URL scheme in the redirected request is + set to https. If set to false, the URL scheme of the redirected request + will remain the same as that of the request. This must only be set for + UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy + is not permitted. The default is set to false. + type: boolean + pathRedirect: + description: The path that will be used in the redirect response instead + of the one that was supplied in the request. pathRedirect cannot be supplied + together with prefixRedirect. Supply one alone or neither. If neither + is supplied, the path of the original request will be used for the redirect. + The value must be between 1 and 1024 characters. + type: string + prefixRedirect: + description: The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, + retaining the remaining portion of the URL before redirecting the request. + prefixRedirect cannot be supplied together with pathRedirect. Supply one + alone or neither. If neither is supplied, the path of the original request + will be used for the redirect. The value must be between 1 and 1024 characters. + type: string + redirectResponseCode: + description: 'The HTTP Status code to use for this RedirectAction. Supported + values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and + corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which + corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In + this case, the request method will be retained. - PERMANENT_REDIRECT, + which corresponds to 308. In this case, the request method will be retained. ' + enum: + - FOUND + - MOVED_PERMANENTLY_DEFAULT + - PERMANENT_REDIRECT + - SEE_OTHER + - TEMPORARY_REDIRECT + type: string + stripQuery: + description: If set to true, any accompanying query portion of the original + URL is removed prior to redirecting the request. If set to false, the + query portion of the original URL is retained. The default is set to false. + type: boolean + type: object + HttpRetryPolicy: + description: The retry policy associates with HttpRouteRule + properties: + numRetries: + description: Specifies the allowed number retries. This number must be > + 0. If not specified, defaults to 1. + format: uint32 + type: integer + perTryTimeout: + $ref: '#/components/schemas/Duration' + description: Specifies a non-zero timeout per retry attempt. If not specified, + will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction + is not set, will use the largest timeout among all backend services associated + with the route. + retryConditions: + description: 'Specifies one or more conditions when this retry policy applies. + Valid values are: - 5xx: Retry will be attempted if the instance or endpoint + responds with any 5xx response code, or if the instance or endpoint does + not respond at all, example: disconnects, reset, read timeout, connection + failure, and refused streams. - gateway-error: Similar to 5xx, but only + applies to response codes 502, 503 or 504. - - connect-failure: A retry + will be attempted on failures connecting to the instance or endpoint, + for example due to connection timeouts. - retriable-4xx: A retry will + be attempted if the instance or endpoint responds with a retriable 4xx + response code. Currently the only retriable error supported is 409. - + refused-stream: A retry will be attempted if the instance or endpoint + resets the stream with a REFUSED_STREAM error code. This reset type indicates + that it is safe to retry. - cancelled: A retry will be attempted if the + gRPC status code in the response header is set to cancelled. - deadline-exceeded: + A retry will be attempted if the gRPC status code in the response header + is set to deadline-exceeded. - internal: A retry will be attempted if + the gRPC status code in the response header is set to internal. - resource-exhausted: + A retry will be attempted if the gRPC status code in the response header + is set to resource-exhausted. - unavailable: A retry will be attempted + if the gRPC status code in the response header is set to unavailable. ' + items: + type: string + type: array + type: object + HttpRouteAction: + properties: + corsPolicy: + $ref: '#/components/schemas/CorsPolicy' + description: The specification for allowing client side cross-origin requests. + Please see W3C Recommendation for Cross Origin Resource Sharing Not supported + when the URL map is bound to target gRPC proxy. + faultInjectionPolicy: + $ref: '#/components/schemas/HttpFaultInjection' + description: The specification for fault injection introduced into traffic + to test the resiliency of clients to backend service failure. As part + of fault injection, when clients send requests to a backend service, delays + can be introduced by Loadbalancer on a percentage of requests before sending + those request to the backend service. Similarly requests from clients + can be aborted by the Loadbalancer for a percentage of requests. For the + requests impacted by fault injection, timeout and retry_policy will be + ignored by clients that are configured with a fault_injection_policy. + maxStreamDuration: + $ref: '#/components/schemas/Duration' + description: Specifies the maximum duration (timeout) for streams on the + selected route. Unlike the timeout field where the timeout duration starts + from the time the request has been fully processed (i.e. end-of-stream), + the duration in this field is computed from the beginning of the stream + until the response has been completely processed, including all retries. + A stream that does not complete in this duration is closed. If not specified, + will use the largest maxStreamDuration among all backend services associated + with the route. This field is only allowed if the Url map is used with + backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED. + requestMirrorPolicy: + $ref: '#/components/schemas/RequestMirrorPolicy' + description: Specifies the policy on how requests intended for the route's + backends are shadowed to a separate mirrored backend service. Loadbalancer + does not wait for responses from the shadow service. Prior to sending + traffic to the shadow service, the host / authority header is suffixed + with -shadow. Not supported when the URL map is bound to target gRPC proxy + that has validateForProxyless field set to true. + retryPolicy: + $ref: '#/components/schemas/HttpRetryPolicy' + description: Specifies the retry policy associated with this route. Not + supported when the URL map is bound to target gRPC proxy that has validateForProxyless + field set to true. + timeout: + $ref: '#/components/schemas/Duration' + description: Specifies the timeout for the selected route. Timeout is computed + from the time the request has been fully processed (i.e. end-of-stream) + up until the response has been completely processed. Timeout includes + all retries. If not specified, will use the largest timeout among all + backend services associated with the route. Not supported when the URL + map is bound to target gRPC proxy that has validateForProxyless field + set to true. + urlRewrite: + $ref: '#/components/schemas/UrlRewrite' + description: The spec to modify the URL of the request, prior to forwarding + the request to the matched service. urlRewrite is the only action supported + in UrlMaps for external HTTP(S) load balancers. Not supported when the + URL map is bound to target gRPC proxy that has validateForProxyless field + set to true. + weightedBackendServices: + description: A list of weighted backend services to send traffic to when + a route match occurs. The weights determine the fraction of traffic that + flows to their corresponding backend service. If all traffic needs to + go to a single backend service, there must be one weightedBackendService + with weight set to a non-zero number. Once a backendService is identified + and before forwarding the request to the backend service, advanced routing + actions such as URL rewrites and header transformations are applied depending + on additional settings specified in this HttpRouteAction. + items: + $ref: '#/components/schemas/WeightedBackendService' + type: array + type: object + HttpRouteRule: + description: An HttpRouteRule specifies how to match an HTTP request and the + corresponding routing action that load balancing proxies will perform. + properties: + description: + description: The short description conveying the intent of this routeRule. + The description can have a maximum length of 1024 characters. + type: string + headerAction: + $ref: '#/components/schemas/HttpHeaderAction' + description: Specifies changes to request and response headers that need + to take effect for the selected backendService. The headerAction specified + here are applied before the matching pathMatchers[].headerAction and after + pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction + Note that headerAction is not supported for Loadbalancers that have their + loadBalancingScheme set to EXTERNAL. Not supported when the URL map is + bound to target gRPC proxy that has validateForProxyless field set to + true. + matchRules: + description: 'The list of criteria for matching attributes of a request + to this routeRule. This list has OR semantics: the request matches this + routeRule when any of the matchRules are satisfied. However predicates + within a given matchRule have AND semantics. All predicates within a matchRule + must match for the request to match the rule.' + items: + $ref: '#/components/schemas/HttpRouteRuleMatch' + type: array + priority: + description: For routeRules within a given pathMatcher, priority determines + the order in which load balancer will interpret routeRules. RouteRules + are evaluated in order of priority, from the lowest to highest number. + The priority of a rule decreases as its number increases (1, 2, 3, N+1). + The first rule that matches the request is applied. You cannot configure + two or more routeRules with the same priority. Priority for each rule + must be set to a number between 0 and 2147483647 inclusive. Priority numbers + can have gaps, which enable you to add or remove rules in the future without + affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 + is a valid series of priority numbers to which you could add rules numbered + from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on + existing rules. + format: int32 + type: integer + routeAction: + $ref: '#/components/schemas/HttpRouteAction' + description: In response to a matching matchRule, the load balancer performs + advanced routing actions like URL rewrites, header transformations, etc. + prior to forwarding the request to the selected backend. If routeAction + specifies any weightedBackendServices, service must not be set. Conversely + if service is set, routeAction cannot contain any weightedBackendServices. + Only one of urlRedirect, service or routeAction.weightedBackendService + must be set. UrlMaps for external HTTP(S) load balancers support only + the urlRewrite action within a routeRule's routeAction. + service: + description: The full or partial URL of the backend service resource to + which traffic is directed if this rule is matched. If routeAction is additionally + specified, advanced routing actions like URL Rewrites, etc. take effect + prior to sending the request to the backend. However, if service is specified, + routeAction cannot contain any weightedBackendService s. Conversely, if + routeAction specifies any weightedBackendServices, service must not be + specified. Only one of urlRedirect, service or routeAction.weightedBackendService + must be set. + type: string + urlRedirect: + $ref: '#/components/schemas/HttpRedirectAction' + description: When this rule is matched, the request is redirected to a URL + specified by urlRedirect. If urlRedirect is specified, service or routeAction + must not be set. Not supported when the URL map is bound to target gRPC + proxy. + type: object + HttpRouteRuleMatch: + description: HttpRouteRuleMatch specifies a set of criteria for matching requests + to an HttpRouteRule. All specified criteria must be satisfied for a match + to occur. + properties: + fullPathMatch: + description: For satisfying the matchRule condition, the path of the request + must exactly match the value specified in fullPathMatch after removing + any query parameters and anchor that may be part of the original URL. + fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, + fullPathMatch or regexMatch must be specified. + type: string + headerMatches: + description: Specifies a list of header match criteria, all of which must + match corresponding headers in the request. + items: + $ref: '#/components/schemas/HttpHeaderMatch' + type: array + ignoreCase: + description: Specifies that prefixMatch and fullPathMatch matches are case + sensitive. The default value is false. ignoreCase must not be used with + regexMatch. Not supported when the URL map is bound to target gRPC proxy. + type: boolean + metadataFilters: + description: Opaque filter criteria used by Loadbalancer to restrict routing + configuration to a limited set of xDS compliant clients. In their xDS + requests to Loadbalancer, xDS clients present node metadata. When there + is a match, the relevant routing configuration is made available to those + proxies. For each metadataFilter in this list, if its filterMatchCriteria + is set to MATCH_ANY, at least one of the filterLabels must match the corresponding + label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, + then all of its filterLabels must match with corresponding labels provided + in the metadata. If multiple metadataFilters are specified, all of them + need to be satisfied in order to be considered a match. metadataFilters + specified here will be applied after those specified in ForwardingRule + that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters + only applies to Loadbalancers that have their loadBalancingScheme set + to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target + gRPC proxy that has validateForProxyless field set to true. + items: + $ref: '#/components/schemas/MetadataFilter' + type: array + prefixMatch: + description: For satisfying the matchRule condition, the request's path + must begin with the specified prefixMatch. prefixMatch must begin with + a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, + fullPathMatch or regexMatch must be specified. + type: string + queryParameterMatches: + description: Specifies a list of query parameter match criteria, all of + which must match corresponding query parameters in the request. Not supported + when the URL map is bound to target gRPC proxy. + items: + $ref: '#/components/schemas/HttpQueryParameterMatch' + type: array + regexMatch: + description: For satisfying the matchRule condition, the path of the request + must satisfy the regular expression specified in regexMatch after removing + any query parameters and anchor supplied with the original URL. For regular + expression grammar please see github.com/google/re2/wiki/Syntax Only one + of prefixMatch, fullPathMatch or regexMatch must be specified. Note that + regexMatch only applies to Loadbalancers that have their loadBalancingScheme + set to INTERNAL_SELF_MANAGED. + type: string + type: object + HttpsHealthCheck: + description: Represents a legacy HTTPS Health Check resource. Legacy HTTPS health + checks have been deprecated. If you are using a target pool-based network + load balancer, you must use a legacy HTTP (not HTTPS) health check. For all + other load balancers, including backend service-based network load balancers, + and for managed instance group auto-healing, you must use modern (non-legacy) + health checks. For more information, see Health checks overview . + properties: + checkIntervalSec: + description: How often (in seconds) to send a health check. The default + value is 5 seconds. + format: int32 + type: integer + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + healthyThreshold: + description: A so-far unhealthy instance will be marked healthy after this + many consecutive successes. The default value is 2. + format: int32 + type: integer + host: + description: The value of the host header in the HTTPS health check request. + If left empty (default value), the public IP on behalf of which this health + check is performed will be used. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#httpsHealthCheck + description: Type of the resource. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + port: + description: The TCP port number for the HTTPS health check request. The + default value is 443. + format: int32 + type: integer + requestPath: + description: The request path of the HTTPS health check request. The default + value is "/". + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + timeoutSec: + description: How long (in seconds) to wait before claiming failure. The + default value is 5 seconds. It is invalid for timeoutSec to have a greater + value than checkIntervalSec. + format: int32 + type: integer + unhealthyThreshold: + description: A so-far healthy instance will be marked unhealthy after this + many consecutive failures. The default value is 2. + format: int32 + type: integer + type: object + HttpsHealthCheckList: + description: Contains a list of HttpsHealthCheck resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of HttpsHealthCheck resources. + items: + $ref: '#/components/schemas/HttpsHealthCheck' + type: array + kind: + default: compute#httpsHealthCheckList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Image: + description: Represents an Image resource. You can use images to create boot + disks for your VM instances. For more information, read Images. + properties: + archiveSizeBytes: + description: Size of the image tar.gz archive stored in Google Cloud Storage + (in bytes). + format: int64 + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: The deprecation status associated with this image. + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + diskSizeGb: + description: Size of the image when restored onto a persistent disk (in + GB). + format: int64 + type: string + family: + description: The name of the image family to which this image belongs. You + can create disks by specifying 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 + 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. + items: + $ref: '#/components/schemas/GuestOsFeature' + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + imageEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: Encrypts the image using a customer-supplied encryption key. + After you encrypt an image with a customer-supplied key, you must provide + the same key if you use the image later (e.g. to create a disk from the + image). Customer-supplied encryption keys do not protect access to metadata + of the disk. If you do not provide an encryption key when creating the + image, then the disk will be encrypted using an automatically generated + key and you do not need to provide a key to use the image later. + kind: + default: compute#image + description: '[Output Only] Type of the resource. Always compute#image for + images.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this image, which + is essentially a hash of the labels used for optimistic locking. The fingerprint + is initially generated by Compute Engine and changes after every request + to modify or update labels. You must always provide an up-to-date fingerprint + hash in order to update or change labels, otherwise the request will fail + with error 412 conditionNotMet. To see the latest fingerprint, make a + get() request to retrieve an image. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this image. These can be later modified + by the setLabels method. + type: object + licenseCodes: + description: Integer license codes indicating which licenses are attached + to this image. + items: + format: int64 + type: string + type: array + licenses: + description: Any applicable license URI. + items: + type: string + type: array + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + rawDisk: + description: The parameters of the raw disk image. + properties: + containerType: + description: The format used to encode and transmit the block device, + which should be TAR. This is just a container and transmission format + and not a runtime format. Provided by the client when the disk image + is created. + enum: + - TAR + type: string + sha1Checksum: + 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 + source: + description: 'The full Google Cloud Storage URL where the raw disk image + archive is stored. The following are valid formats for the URL: - + https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ + image_archive_name In order to create an image, you must provide the + full or partial URL of one of the following: - The rawDisk.source + URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot + URL ' + type: string + type: object + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + shieldedInstanceInitialState: + $ref: '#/components/schemas/InitialStateConfig' + description: Set the secure boot keys of shielded instance. + sourceDisk: + description: 'URL of the source disk used to create this image. For example, + the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + In order to create an image, you must provide the full or partial URL + of one of the following: - The rawDisk.source URL - The sourceDisk URL + - The sourceImage URL - The sourceSnapshot URL ' + type: string + sourceDiskEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source disk. Required + if the source disk is protected by a customer-supplied encryption key. + sourceDiskId: + description: '[Output Only] The ID value of the disk used to create this + image. This value may be used to determine whether the image was taken + from the current or a previous instance of a given disk name.' + type: string + sourceImage: + description: 'URL of the source image used to create this image. The following + are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ + images/image_name - projects/project_id/global/images/image_name In order + to create an image, you must provide the full or partial URL of one of + the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage + URL - The sourceSnapshot URL ' + type: string + sourceImageEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption key. + sourceImageId: + description: '[Output Only] The ID value of the image used to create this + image. This value may be used to determine whether the image was taken + from the current or a previous instance of a given image name.' + type: string + sourceSnapshot: + description: 'URL of the source snapshot used to create this image. The + following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ + snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name + In order to create an image, you must provide the full or partial URL + of one of the following: - The rawDisk.source URL - The sourceDisk URL + - The sourceImage URL - The sourceSnapshot URL ' + type: string + sourceSnapshotEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source snapshot. + Required if the source snapshot is protected by a customer-supplied encryption + key. + sourceSnapshotId: + description: '[Output Only] The ID value of the snapshot used to create + this image. This value may be used to determine whether the snapshot was + taken from the current or a previous instance of a given snapshot name.' + type: string + sourceType: + default: RAW + description: The type of the image used to create this disk. The default + and only value is RAW + enum: + - RAW + type: string + status: + description: '[Output Only] The status of the image. An image can be used + to create other resources, such as instances, only after the image has + been successfully created and the status is set to READY. Possible values + are FAILED, PENDING, or READY.' + enum: + - DELETING + - FAILED + - PENDING + - READY + type: string + storageLocations: + description: Cloud Storage bucket storage location of the image (regional + or multi-regional). + items: + type: string + type: array + type: object + ImageFamilyView: + properties: + image: + $ref: '#/components/schemas/Image' + description: The latest image that is part of the specified image family + in the requested location, and that is not deprecated. + type: object + ImageList: + description: Contains a list of images. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Image resources. + items: + $ref: '#/components/schemas/Image' + type: array + kind: + default: compute#imageList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InitialStateConfig: + description: Initial State for shielded instance, these are public keys which + are safe to store in public + properties: + dbs: + description: The Key Database (db). + items: + $ref: '#/components/schemas/FileContentBuffer' + type: array + dbxs: + description: The forbidden key database (dbx). + items: + $ref: '#/components/schemas/FileContentBuffer' + type: array + keks: + description: The Key Exchange Key (KEK). + items: + $ref: '#/components/schemas/FileContentBuffer' + type: array + pk: + $ref: '#/components/schemas/FileContentBuffer' + description: The Platform Key (PK). + type: object + Instance: + description: Represents an Instance resource. An instance is a virtual machine + that is hosted on Google Cloud Platform. For more information, read Virtual + Machine Instances. + properties: + advancedMachineFeatures: + $ref: '#/components/schemas/AdvancedMachineFeatures' + description: Controls for advanced machine-related behavior features. + canIpForward: + description: Allows this instance to send and receive packets with non-matching + destination or source IPs. This is required if you plan to use this instance + to forward routes. For more information, see Enabling IP Forwarding . + type: boolean + confidentialInstanceConfig: + $ref: '#/components/schemas/ConfidentialInstanceConfig' + cpuPlatform: + description: '[Output Only] The CPU platform used by this instance.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deletionProtection: + description: Whether the resource should be protected against deletion. + type: boolean + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + disks: + description: Array of disks associated with this instance. Persistent disks + must be created before you can assign them. + items: + $ref: '#/components/schemas/AttachedDisk' + type: array + displayDevice: + $ref: '#/components/schemas/DisplayDevice' + description: Enables display device for the instance. + fingerprint: + description: Specifies a fingerprint for this resource, which is essentially + a hash of the instance's contents and used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update the instance. You must always provide + an up-to-date fingerprint hash in order to update the instance. To see + the latest fingerprint, make get() request to the instance. + format: byte + type: string + guestAccelerators: + description: A list of the type and count of accelerator cards attached + to the instance. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + hostname: + description: Specifies the hostname of the instance. The specified hostname + must be RFC1035 compliant. If hostname is not specified, the default hostname + is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, + and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#instance + description: '[Output Only] Type of the resource. Always compute#instance + for instances.' + type: string + labelFingerprint: + description: A fingerprint for this request, which is essentially a hash + of the label's contents and used for optimistic locking. The fingerprint + is initially generated by Compute Engine and changes after every request + to modify or update labels. You must always provide an up-to-date fingerprint + hash in order to update or change labels. To see the latest fingerprint, + make get() request to the instance. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this instance. These can be later modified + by the setLabels method. + type: object + lastStartTimestamp: + description: '[Output Only] Last start timestamp in RFC3339 text format.' + type: string + lastStopTimestamp: + description: '[Output Only] Last stop timestamp in RFC3339 text format.' + type: string + lastSuspendedTimestamp: + description: '[Output Only] Last suspended timestamp in RFC3339 text format.' + type: string + machineType: + description: 'Full or partial URL of the machine type resource to use for + this instance, in the format: zones/zone/machineTypes/machine-type. This + is provided by the client when the instance is created. For example, the + following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 + To create a custom machine type, provide a URL to a machine type in the + following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, + ... 24, etc), and MEMORY is the total memory for this instance. Memory + must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of + memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: + zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, + read the Specifications for custom machine types.' + type: string + metadata: + $ref: '#/components/schemas/Metadata' + description: The metadata key/value pairs assigned to this instance. This + includes custom metadata and predefined keys. + minCpuPlatform: + description: 'Specifies a minimum CPU platform for the VM instance. Applicable + values are the friendly names of CPU platforms, such as minCpuPlatform: + "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".' + type: string + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + networkInterfaces: + description: An array of network configurations for this instance. These + specify how interfaces are configured to interact with other network services, + such as connecting to the internet. Multiple interfaces are supported + per instance. + items: + $ref: '#/components/schemas/NetworkInterface' + type: array + privateIpv6GoogleAccess: + description: The private IPv6 google access type for the VM. If not specified, + use INHERIT_FROM_SUBNETWORK as default. + enum: + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + - INHERIT_FROM_SUBNETWORK + type: string + reservationAffinity: + $ref: '#/components/schemas/ReservationAffinity' + description: Specifies the reservations that this instance can consume from. + resourcePolicies: + description: Resource policies applied to this instance. + items: + type: string + type: array + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + scheduling: + $ref: '#/components/schemas/Scheduling' + description: Sets the scheduling options for this instance. + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + serviceAccounts: + description: A list of service accounts, with their specified scopes, authorized + for this instance. Only one service account per VM instance is supported. + Service accounts generate access tokens that can be accessed through the + metadata server and used to authenticate applications on the instance. + See Service Accounts for more information. + items: + $ref: '#/components/schemas/ServiceAccount' + type: array + shieldedInstanceConfig: + $ref: '#/components/schemas/ShieldedInstanceConfig' + shieldedInstanceIntegrityPolicy: + $ref: '#/components/schemas/ShieldedInstanceIntegrityPolicy' + startRestricted: + description: '[Output Only] Whether a VM has been restricted for start because + Compute Engine has detected suspicious activity.' + type: boolean + status: + description: '[Output Only] The status of the instance. One of the following + values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, + REPAIRING, and TERMINATED. For more information about the status of the + instance, see Instance life cycle.' + enum: + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED + type: string + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the + status.' + type: string + tags: + $ref: '#/components/schemas/Tags' + description: Tags to apply to this instance. Tags are used to identify valid + sources or targets for network firewalls and are specified by the client + during instance creation. The tags can be later modified by the setTags + method. Each tag within the list must comply with RFC1035. Multiple tags + can be specified via the 'tags.items' field. + zone: + description: '[Output Only] URL of the zone where the instance resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + type: object + InstanceAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/InstancesScopedList' + description: '[Output Only] Name of the scope containing this set of instances.' + description: An object that contains a list of instances scoped by zone. + type: object + kind: + default: compute#instanceAggregatedList + description: '[Output Only] Type of resource. Always compute#instanceAggregatedList + for aggregated lists of Instance resources.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroup: + description: Represents an Instance Group resource. Instance Groups can be used + to configure a target for load balancing. Instance groups can either be managed + or unmanaged. To create managed instance groups, use the instanceGroupManager + or regionInstanceGroupManager resource instead. Use zonal unmanaged instance + groups if you need to apply load balancing to groups of heterogeneous instances + or if you need to manage the instances yourself. You cannot create regional + unmanaged instance groups. For more information, read Instance groups. + properties: + creationTimestamp: + description: '[Output Only] The creation timestamp for this instance group + in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: '[Output Only] The fingerprint of the named ports. The system + uses this fingerprint to detect conflicts when multiple users change the + named ports concurrently.' + format: byte + type: string + id: + description: '[Output Only] A unique identifier for this instance group, + generated by the server.' + format: uint64 + type: string + kind: + default: compute#instanceGroup + description: '[Output Only] The resource type, which is always compute#instanceGroup + for instance groups.' + type: string + name: + description: The name of the instance group. 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 + namedPorts: + description: ' Assigns a name to a port number. For example: {name: "http", + port: 80} This allows the system to reference ports by the assigned name + instead of a port number. Named ports can also contain multiple ports. + For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named + ports apply to all instances in this instance group. ' + items: + $ref: '#/components/schemas/NamedPort' + type: array + network: + description: '[Output Only] The URL of the network to which all instances + in the instance group belong. If your instance has multiple network interfaces, + then the network and subnetwork fields only refer to the network and subnet + used by your primary interface (nic0).' + type: string + region: + description: '[Output Only] The URL of the region where the instance group + is located (for regional resources).' + type: string + selfLink: + description: '[Output Only] The URL for this instance group. The server + generates this URL.' + type: string + size: + description: '[Output Only] The total number of instances in the instance + group.' + format: int32 + type: integer + subnetwork: + description: '[Output Only] The URL of the subnetwork to which all instances + in the instance group belong. If your instance has multiple network interfaces, + then the network and subnetwork fields only refer to the network and subnet + used by your primary interface (nic0).' + type: string + zone: + description: '[Output Only] The URL of the zone where the instance group + is located (for zonal resources).' + type: string + type: object + InstanceGroupAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/InstanceGroupsScopedList' + description: The name of the scope that contains this set of instance + groups. + description: A list of InstanceGroupsScopedList resources. + type: object + kind: + default: compute#instanceGroupAggregatedList + description: '[Output Only] The resource type, which is always compute#instanceGroupAggregatedList + for aggregated lists of instance groups.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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. + 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: '#/components/schemas/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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManager: + description: Represents a Managed Instance Group resource. An instance group + is a collection of VM instances that you can manage as a single entity. For + more information, read Instance groups. For zonal Managed Instance Group, + use the instanceGroupManagers resource. For regional Managed Instance Group, + use the regionInstanceGroupManagers resource. + properties: + autoHealingPolicies: + description: The autohealing policy for this managed instance group. You + can specify only one value. + items: + $ref: '#/components/schemas/InstanceGroupManagerAutoHealingPolicy' + type: array + baseInstanceName: + description: The base instance name to use for instances in this group. + The value must be 1-58 characters long. Instances are named by appending + a hyphen and a random four-character string to the base instance name. + The base instance name must comply with RFC1035. + pattern: '[a-z][-a-z0-9]{0,57}' + type: string + creationTimestamp: + description: '[Output Only] The creation timestamp for this managed instance + group in RFC3339 text format.' + type: string + currentActions: + $ref: '#/components/schemas/InstanceGroupManagerActionsSummary' + description: '[Output Only] The list of instance actions and the number + of instances in this managed instance group that are scheduled for each + of those actions.' + description: + description: An optional description of this resource. + type: string + distributionPolicy: + $ref: '#/components/schemas/DistributionPolicy' + description: Policy specifying the intended distribution of managed instances + across zones in a regional managed instance group. + fingerprint: + description: 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. + format: byte + type: string + id: + description: '[Output Only] A unique identifier for this resource type. + The server generates this identifier.' + format: uint64 + type: string + instanceGroup: + description: '[Output Only] The URL of the Instance Group resource.' + type: string + 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 + kind: + default: compute#instanceGroupManager + description: '[Output Only] The resource type, which is always compute#instanceGroupManager + for managed instance groups.' + type: string + name: + description: The name of the managed instance group. 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 + namedPorts: + description: Named ports configured for the Instance Groups complementary + to this Instance Group Manager. + items: + $ref: '#/components/schemas/NamedPort' + type: array + region: + description: '[Output Only] The URL of the region where the managed instance + group resides (for regional resources).' + type: string + selfLink: + description: '[Output Only] The URL for this managed instance group. The + server defines this URL.' + type: string + statefulPolicy: + $ref: '#/components/schemas/StatefulPolicy' + description: Stateful configuration for this Instanced Group Manager + status: + $ref: '#/components/schemas/InstanceGroupManagerStatus' + description: '[Output Only] The status of this managed instance group.' + targetPools: + description: The URLs for all TargetPool resources to which instances in + the instanceGroup field are added. The target pools automatically apply + to all of the instances in the managed instance group. + items: + type: string + type: array + targetSize: + description: The target number of running instances for this managed instance + group. You can reduce this number by using the instanceGroupManager deleteInstances + or abandonInstances methods. Resizing the group also changes this number. + format: int32 + type: integer + updatePolicy: + $ref: '#/components/schemas/InstanceGroupManagerUpdatePolicy' + description: The update policy for this managed instance group. + versions: + description: Specifies the instance templates used by this managed instance + group to create instances. Each version is defined by an instanceTemplate + and a name. Every version can appear at most once per instance group. + This field overrides the top-level instanceTemplate field. Read more about + the relationships between these fields. Exactly one version must leave + the targetSize field unset. That version will be applied to all remaining + instances. For more information, read about canary updates. + items: + $ref: '#/components/schemas/InstanceGroupManagerVersion' + type: array + zone: + description: '[Output Only] The URL of a zone where the managed instance + group is located (for zonal resources).' + type: string + type: object + InstanceGroupManagerActionsSummary: + properties: + abandoning: + description: '[Output Only] The total number of instances in the managed + instance group that are scheduled to be abandoned. Abandoning an instance + removes it from the managed instance group without deleting it.' + format: int32 + type: integer + creating: + description: '[Output Only] The number of instances in the managed instance + group that are scheduled to be created or are currently being created. + If the group fails to create any of these instances, it tries again until + it creates the instance successfully. If you have disabled creation retries, + this field will not be populated; instead, the creatingWithoutRetries + field will be populated.' + format: int32 + type: integer + creatingWithoutRetries: + description: '[Output Only] The number of instances that the managed instance + group will attempt to create. The group attempts to create each instance + only once. If the group fails to create any of these instances, it decreases + the group''s targetSize value accordingly.' + format: int32 + type: integer + deleting: + description: '[Output Only] The number of instances in the managed instance + group that are scheduled to be deleted or are currently being deleted.' + format: int32 + type: integer + none: + description: '[Output Only] The number of instances in the managed instance + group that are running and have no scheduled actions.' + format: int32 + type: integer + recreating: + description: '[Output Only] The number of instances in the managed instance + group that are scheduled to be recreated or are currently being being + recreated. Recreating an instance deletes the existing root persistent + disk and creates a new disk from the image that is defined in the instance + template.' + format: int32 + type: integer + refreshing: + description: '[Output Only] The number of instances in the managed instance + group that are being reconfigured with properties that do not require + a restart or a recreate action. For example, setting or removing target + pools for the instance.' + format: int32 + type: integer + restarting: + description: '[Output Only] The number of instances in the managed instance + group that are scheduled to be restarted or are currently being restarted.' + format: int32 + type: integer + verifying: + description: '[Output Only] The number of instances in the managed instance + group that are being verified. See the managedInstances[].currentAction + property in the listManagedInstances method documentation.' + format: int32 + type: integer + type: object + InstanceGroupManagerAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/InstanceGroupManagersScopedList' + description: '[Output Only] The name of the scope that contains this set + of managed instance groups.' + description: A list of InstanceGroupManagersScopedList resources. + type: object + kind: + default: compute#instanceGroupManagerAggregatedList + description: '[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList + for an aggregated list of managed instance groups.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManagerAutoHealingPolicy: + properties: + healthCheck: + description: The URL for the health check that signals autohealing. + type: string + initialDelaySec: + description: The number of seconds that the managed instance group waits + before it applies autohealing policies to new instances or recently recreated + instances. This initial delay allows instances to initialize and run their + startup scripts before the instance group determines that they are UNHEALTHY. + This prevents the managed instance group from recreating its instances + prematurely. This value must be from range [0, 3600]. + format: int32 + type: integer + type: object + InstanceGroupManagerList: + description: '[Output Only] A list of managed instance groups.' + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceGroupManager resources. + items: + $ref: '#/components/schemas/InstanceGroupManager' + type: array + kind: + default: compute#instanceGroupManagerList + description: '[Output Only] The resource type, which is always compute#instanceGroupManagerList + for a list of managed instance groups.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManagerStatus: + properties: + autoscaler: + description: '[Output Only] The URL of the Autoscaler that targets this + instance group manager.' + type: string + isStable: + description: '[Output Only] A bit indicating whether the managed instance + group is in a stable state. A stable state means that: none of the instances + in the managed instance group is currently undergoing any type of change + (for example, creation, restart, or deletion); no future changes are scheduled + for instances in the managed instance group; and the managed instance + group itself is not being modified.' + type: boolean + stateful: + $ref: '#/components/schemas/InstanceGroupManagerStatusStateful' + description: '[Output Only] Stateful status of the given Instance Group + Manager.' + versionTarget: + $ref: '#/components/schemas/InstanceGroupManagerStatusVersionTarget' + description: '[Output Only] A status of consistency of Instances'' versions + with their target version specified by version field on Instance Group + Manager.' + type: object + InstanceGroupManagerStatusStateful: + properties: + hasStatefulConfig: + 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 config 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.' + type: boolean + perInstanceConfigs: + $ref: '#/components/schemas/InstanceGroupManagerStatusStatefulPerInstanceConfigs' + description: '[Output Only] Status of per-instance configs on the instance.' + type: object + InstanceGroupManagerStatusStatefulPerInstanceConfigs: + properties: + allEffective: + description: A bit indicating if all of the group's per-instance configs + (listed in the output of a listPerInstanceConfigs API call) have status + EFFECTIVE or there are no per-instance-configs. + type: boolean + type: object + InstanceGroupManagerStatusVersionTarget: + properties: + isReached: + description: '[Output Only] A bit indicating whether version target has + been reached in this managed instance group, i.e. all instances are in + their target version. Instances'' target version are specified by version + field on Instance Group Manager.' + type: boolean + type: object + InstanceGroupManagerUpdatePolicy: + properties: + instanceRedistributionType: + description: 'The instance redistribution policy for regional managed instance + groups. Valid values are: - PROACTIVE (default): The group attempts to + maintain an even distribution of VM instances across zones in the region. + - NONE: For non-autoscaled groups, proactive redistribution is disabled. ' + enum: + - NONE + - PROACTIVE + type: string + maxSurge: + $ref: '#/components/schemas/FixedOrPercent' + description: The maximum number of instances that can be created above the + specified targetSize during the update process. This value can be either + a fixed number or, if the group has 10 or more instances, a percentage. + If you set a percentage, the number of instances is rounded if necessary. + The default value for maxSurge is a fixed value equal to the number of + zones in which the managed instance group operates. At least one of either + maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. + maxUnavailable: + $ref: '#/components/schemas/FixedOrPercent' + description: 'The maximum number of instances that can be unavailable during + the update process. An instance is considered available if all of the + following conditions are satisfied: - The instance''s status is RUNNING. + - If there is a health check on the instance group, the instance''s health + check status must be HEALTHY at least once. If there is no health check + on the group, then the instance only needs to have a status of RUNNING + to be considered available. This value can be either a fixed number or, + if the group has 10 or more instances, a percentage. If you set a percentage, + the number of instances is rounded if necessary. The default value for + maxUnavailable is a fixed value equal to the number of zones in which + the managed instance group operates. At least one of either maxSurge or + maxUnavailable must be greater than 0. Learn more about maxUnavailable.' + minimalAction: + description: Minimal action to be taken on an instance. You can specify + either RESTART to restart existing instances or REPLACE to delete and + create new instances from the target template. If you specify a RESTART, + the Updater will attempt to perform that action only. However, if the + Updater determines that the minimal action you specify is not enough to + perform the update, it might perform a more disruptive action. + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + replacementMethod: + description: What action should be used to replace instances. See minimal_action.REPLACE + enum: + - RECREATE + - SUBSTITUTE + type: string + type: + description: The type of update process. You can specify either PROACTIVE + so that the instance group manager proactively executes actions in order + to bring instances to their target versions or OPPORTUNISTIC so that no + action is proactively executed but the update will be performed as part + of other actions (for example, resizes or recreateInstances calls). + enum: + - OPPORTUNISTIC + - PROACTIVE + type: string + type: object + InstanceGroupManagerVersion: + properties: + instanceTemplate: + description: The URL of the instance template that is specified for this + managed instance group. The group uses this template to create new instances + in the managed instance group until the `targetSize` for this version + is reached. 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; in those cases, existing instances + are updated until the `targetSize` for this version is reached. + type: string + name: + description: Name of the version. Unique among all versions in the scope + of this managed instance group. + type: string + targetSize: + $ref: '#/components/schemas/FixedOrPercent' + description: 'Specifies the intended number of instances to be created from + the instanceTemplate. The final number of instances created from the template + will be equal to: - If expressed as a fixed number, the minimum of either + targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed + as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) + If there is a remainder, the number is rounded. If unset, this version + will update any remaining instances not updated by another version. Read + Starting a canary update for more information.' + type: object + InstanceGroupManagersAbandonInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to abandon. This can be a + full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + type: object + InstanceGroupManagersApplyUpdatesRequest: + description: InstanceGroupManagers.applyUpdatesToInstances + properties: + allInstances: + description: "Flag to update all instances instead of specified list of\ + \ \u201Cinstances\u201D. If the flag is set to true then the instances\ + \ may not be specified in the request." + type: boolean + instances: + description: The list of URLs of one or more instances for which you want + to apply updates. Each URL can be a full URL or a partial URL, such as + zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + minimalAction: + description: 'The minimal action that you want to perform on each instance + during the update: - REPLACE: At minimum, delete the instance and create + it again. - RESTART: Stop the instance and start it again. - REFRESH: + Do not stop the instance. - NONE: Do not disrupt the instance at all. + By default, the minimum action is NONE. If your update requires a more + disruptive action than you set with this flag, the necessary action is + performed to execute the update.' + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + mostDisruptiveAllowedAction: + description: 'The most disruptive action that you want to perform on each + instance during the update: - REPLACE: Delete the instance and create + it again. - RESTART: Stop the instance and start it again. - REFRESH: + Do not stop the instance. - NONE: Do not disrupt the instance at all. + By default, the most disruptive allowed action is REPLACE. If your update + requires a more disruptive action than you set with this flag, the update + request will fail.' + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + type: object + InstanceGroupManagersCreateInstancesRequest: + description: InstanceGroupManagers.createInstances + properties: + instances: + description: '[Required] List of specifications of per-instance configs.' + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + InstanceGroupManagersDeleteInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to delete. This can be a + full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + skipInstancesOnValidationError: + description: Specifies whether the request should proceed despite the inclusion + of instances that are not members of the group or that are already in + the process of being deleted or abandoned. If this field is set to `false` + and such an instance is specified in the request, the operation fails. + The operation always fails if the request contains a malformed instance + URL or a reference to an instance that exists in a zone or region other + than the group's zone or region. + type: boolean + type: object + InstanceGroupManagersDeletePerInstanceConfigsReq: + description: InstanceGroupManagers.deletePerInstanceConfigs + properties: + names: + description: The list of instance names for which we want to delete per-instance + configs on this managed instance group. + items: + type: string + type: array + type: object + InstanceGroupManagersListErrorsResponse: + properties: + items: + description: '[Output Only] The list of errors of the managed instance group.' + items: + $ref: '#/components/schemas/InstanceManagedByIgmError' + type: array + 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 + type: object + InstanceGroupManagersListManagedInstancesResponse: + properties: + managedInstances: + description: '[Output Only] The list of instances in the managed instance + group.' + items: + $ref: '#/components/schemas/ManagedInstance' + type: array + 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 + type: object + InstanceGroupManagersListPerInstanceConfigsResp: + properties: + items: + description: '[Output Only] The list of PerInstanceConfig.' + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManagersPatchPerInstanceConfigsReq: + description: InstanceGroupManagers.patchPerInstanceConfigs + properties: + perInstanceConfigs: + description: The list of per-instance configs to insert or patch on this + managed instance group. + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + InstanceGroupManagersRecreateInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to recreate. This can be + a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + type: object + InstanceGroupManagersScopedList: + properties: + instanceGroupManagers: + description: '[Output Only] The list of managed instance groups that are + contained in the specified project and zone.' + items: + $ref: '#/components/schemas/InstanceGroupManager' + type: array + warning: + description: '[Output Only] The warning that replaces the list of managed + instance groups 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManagersSetInstanceTemplateRequest: + properties: + 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 + type: object + InstanceGroupManagersSetTargetPoolsRequest: + properties: + fingerprint: + description: The fingerprint of the target pools information. Use this optional + property to prevent conflicts when multiple users change the target pools + settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get + method. Then, include the fingerprint in your request to ensure that you + do not overwrite changes that were applied from another concurrent request. + format: byte + type: string + targetPools: + description: The list of target pool URLs that instances in this managed + instance group belong to. The managed instance group applies these target + pools to all of the instances in the group. Existing instances and new + instances in the group all receive these target pool settings. + items: + type: string + type: array + type: object + InstanceGroupManagersUpdatePerInstanceConfigsReq: + description: InstanceGroupManagers.updatePerInstanceConfigs + properties: + perInstanceConfigs: + description: The list of per-instance configs to insert or patch on this + managed instance group. + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + InstanceGroupsAddInstancesRequest: + properties: + instances: + description: The list of instances to add to the instance group. + items: + $ref: '#/components/schemas/InstanceReference' + type: array + type: object + InstanceGroupsListInstances: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceWithNamedPorts resources. + items: + $ref: '#/components/schemas/InstanceWithNamedPorts' + type: array + kind: + default: compute#instanceGroupsListInstances + description: '[Output Only] The resource type, which is always compute#instanceGroupsListInstances + for the list of instances in the specified instance group.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupsListInstancesRequest: + properties: + instanceState: + description: A filter for the state of the instances in the instance group. + Valid options are ALL or RUNNING. If you do not specify this parameter + the list includes all instances regardless of their state. + enum: + - ALL + - RUNNING + type: string + type: object + InstanceGroupsRemoveInstancesRequest: + properties: + instances: + description: The list of instances to remove from the instance group. + items: + $ref: '#/components/schemas/InstanceReference' + type: array + type: object + InstanceGroupsScopedList: + properties: + instanceGroups: + description: '[Output Only] The list of instance groups that are contained + in this scope.' + items: + $ref: '#/components/schemas/InstanceGroup' + type: array + warning: + description: '[Output Only] An informational warning that replaces the list + of instance groups 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupsSetNamedPortsRequest: + properties: + fingerprint: + description: The fingerprint of the named ports information for this instance + group. Use this optional property to prevent conflicts when multiple users + change the named ports settings concurrently. Obtain the fingerprint with + the instanceGroups.get method. Then, include the fingerprint in your request + to ensure that you do not overwrite changes that were applied from another + concurrent request. A request with an incorrect fingerprint will fail + with error 412 conditionNotMet. + format: byte + type: string + namedPorts: + description: The list of named ports to set for this instance group. + items: + $ref: '#/components/schemas/NamedPort' + type: array + type: object + InstanceList: + description: Contains a list of instances. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Instance resources. + items: + $ref: '#/components/schemas/Instance' + type: array + kind: + default: compute#instanceList + description: '[Output Only] Type of resource. Always compute#instanceList + for lists of Instance resources.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceListReferrers: + description: Contains a list of instance referrers. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Reference resources. + items: + $ref: '#/components/schemas/Reference' + type: array + kind: + default: compute#instanceListReferrers + description: '[Output Only] Type of resource. Always compute#instanceListReferrers + for lists of Instance referrers.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceManagedByIgmError: + properties: + error: + $ref: '#/components/schemas/InstanceManagedByIgmErrorManagedInstanceError' + description: '[Output Only] Contents of the error.' + instanceActionDetails: + $ref: '#/components/schemas/InstanceManagedByIgmErrorInstanceActionDetails' + description: '[Output Only] Details of the instance action that triggered + this error. May be null, if the error was not caused by an action on an + instance. This field is optional.' + timestamp: + description: '[Output Only] The time that this error occurred. This value + is in RFC3339 text format.' + type: string + type: object + InstanceManagedByIgmErrorInstanceActionDetails: + properties: + action: + description: '[Output Only] Action that managed instance group was executing + on the instance when the error occurred. Possible values:' + enum: + - ABANDONING + - CREATING + - CREATING_WITHOUT_RETRIES + - DELETING + - NONE + - RECREATING + - REFRESHING + - RESTARTING + - VERIFYING + type: string + instance: + description: '[Output Only] The URL of the instance. The URL can be set + even if the instance has not yet been created.' + type: string + version: + $ref: '#/components/schemas/ManagedInstanceVersion' + description: '[Output Only] Version this instance was created from, or was + being created from, but the creation failed. Corresponds to one of the + versions that were set on the Instance Group Manager resource at the time + this instance was being created.' + type: object + InstanceManagedByIgmErrorManagedInstanceError: + properties: + code: + description: '[Output Only] Error code.' + type: string + message: + description: '[Output Only] Error message.' + type: string + type: object + InstanceMoveRequest: + properties: + destinationZone: + description: 'The URL of the destination zone to move the instance. This + can be a full or partial URL. For example, the following are all valid + URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + - projects/project/zones/zone - zones/zone ' + type: string + targetInstance: + description: 'The URL of the target instance to move. This can be a full + or partial URL. For example, the following are all valid URLs to an instance: + - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance + - projects/project/zones/zone/instances/instance - zones/zone/instances/instance ' + type: string + type: object + InstanceProperties: + properties: + advancedMachineFeatures: + $ref: '#/components/schemas/AdvancedMachineFeatures' + description: Controls for advanced machine-related behavior features. Note + that for MachineImage, this is not supported yet. + canIpForward: + description: Enables instances created based on these properties to send + packets with source IP addresses other than their own and receive packets + with destination IP addresses other than their own. If these instances + will be used as an IP gateway or it will be set as the next-hop in a Route + resource, specify true. If unsure, leave this set to false. See the Enable + IP forwarding documentation for more information. + type: boolean + confidentialInstanceConfig: + $ref: '#/components/schemas/ConfidentialInstanceConfig' + description: Specifies the Confidential Instance options. Note that for + MachineImage, this is not supported yet. + description: + description: An optional text description for the instances that are created + from these properties. + type: string + disks: + description: An array of disks that are associated with the instances that + are created from these properties. + items: + $ref: '#/components/schemas/AttachedDisk' + type: array + guestAccelerators: + description: A list of guest accelerator cards' type and count to use for + instances created from these properties. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + labels: + additionalProperties: + type: string + description: Labels to apply to instances that are created from these properties. + type: object + machineType: + description: The machine type to use for instances that are created from + these properties. + type: string + metadata: + $ref: '#/components/schemas/Metadata' + description: The metadata key/value pairs to assign to instances that are + created from these properties. These pairs can consist of custom metadata + or predefined keys. See Project and instance metadata for more information. + minCpuPlatform: + description: 'Minimum cpu/platform to be used by instances. The instance + may be scheduled on the specified or newer cpu/platform. Applicable values + are the friendly names of CPU platforms, such as minCpuPlatform: "Intel + Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, + read Specifying a Minimum CPU Platform.' + type: string + networkInterfaces: + description: An array of network access configurations for this interface. + items: + $ref: '#/components/schemas/NetworkInterface' + type: array + privateIpv6GoogleAccess: + description: The private IPv6 google access type for VMs. If not specified, + use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this + is not supported yet. + enum: + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + - INHERIT_FROM_SUBNETWORK + type: string + reservationAffinity: + $ref: '#/components/schemas/ReservationAffinity' + description: Specifies the reservations that instances can consume from. + Note that for MachineImage, this is not supported yet. + resourcePolicies: + description: Resource policies (names, not ULRs) applied to instances created + from these properties. Note that for MachineImage, this is not supported + yet. + items: + type: string + type: array + scheduling: + $ref: '#/components/schemas/Scheduling' + description: Specifies the scheduling options for the instances that are + created from these properties. + serviceAccounts: + description: A list of service accounts with specified scopes. Access tokens + for these service accounts are available to the instances that are created + from these properties. Use metadata queries to obtain the access tokens + for these instances. + items: + $ref: '#/components/schemas/ServiceAccount' + type: array + shieldedInstanceConfig: + $ref: '#/components/schemas/ShieldedInstanceConfig' + description: Note that for MachineImage, this is not supported yet. + tags: + $ref: '#/components/schemas/Tags' + description: A list of tags to apply to the instances that are created from + these properties. The tags identify valid sources or targets for network + firewalls. The setTags method can modify this list of tags. Each tag within + the list must comply with RFC1035. + type: object + InstanceReference: + properties: + instance: + description: The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances + type: string + type: object + InstanceTemplate: + description: Represents an Instance Template resource. You can use instance + templates to create VM instances and managed instance groups. For more information, + read Instance Templates. + properties: + creationTimestamp: + description: '[Output Only] The creation timestamp for this instance template + in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] A unique identifier for this instance template. + The server defines this identifier.' + format: uint64 + type: string + kind: + default: compute#instanceTemplate + description: '[Output Only] The resource type, which is always compute#instanceTemplate + for instance templates.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + properties: + $ref: '#/components/schemas/InstanceProperties' + description: The instance properties for this instance template. + selfLink: + description: '[Output Only] The URL for this instance template. The server + defines this URL.' + type: string + sourceInstance: + description: 'The source instance used to create the template. You can provide + this as a partial or full URL to the resource. For example, the following + are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /instances/instance - projects/project/zones/zone/instances/instance ' + type: string + sourceInstanceParams: + $ref: '#/components/schemas/SourceInstanceParams' + description: The source instance params to use to create this instance template. + type: object + InstanceTemplateList: + description: A list of instance templates. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceTemplate resources. + items: + $ref: '#/components/schemas/InstanceTemplate' + type: array + kind: + default: compute#instanceTemplateList + description: '[Output Only] The resource type, which is always compute#instanceTemplatesListResponse + for instance template 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceWithNamedPorts: + properties: + instance: + description: '[Output Only] The URL of the instance.' + type: string + namedPorts: + description: '[Output Only] The named ports that belong to this instance + group.' + items: + $ref: '#/components/schemas/NamedPort' + type: array + status: + description: '[Output Only] The status of the instance.' + enum: + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED + type: string + type: object + InstancesAddResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be added to this instance. + items: + type: string + type: array + type: object + InstancesGetEffectiveFirewallsResponse: + properties: + firewallPolicys: + description: Effective firewalls from firewall policies. + items: + $ref: '#/components/schemas/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy' + type: array + firewalls: + description: Effective firewalls on the instance. + items: + $ref: '#/components/schemas/Firewall' + type: array + type: object + InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy: + properties: + displayName: + description: '[Output Only] Deprecated, please use short name instead. The + display name of the firewall policy.' + type: string + name: + description: '[Output Only] The name of the firewall policy.' + type: string + rules: + description: The rules that apply to the network. + items: + $ref: '#/components/schemas/FirewallPolicyRule' + type: array + shortName: + description: '[Output Only] The short name of the firewall policy.' + type: string + type: + description: '[Output Only] The type of the firewall policy.' + enum: + - HIERARCHY + - UNSPECIFIED + type: string + type: object + InstancesRemoveResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be removed from this instance. + items: + type: string + type: array + type: object + InstancesScopedList: + properties: + instances: + description: '[Output Only] A list of instances contained in this scope.' + items: + $ref: '#/components/schemas/Instance' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of instances 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstancesSetLabelsRequest: + properties: + labelFingerprint: + description: Fingerprint of the previous set of labels for this resource, + used to prevent conflicts. Provide the latest fingerprint value when making + a request to add or change labels. + format: byte + type: string + labels: + additionalProperties: + type: string + type: object + type: object + InstancesSetMachineResourcesRequest: + properties: + guestAccelerators: + description: A list of the type and count of accelerator cards attached + to the instance. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + type: object + InstancesSetMachineTypeRequest: + properties: + machineType: + description: 'Full or partial URL of the machine type resource. See Machine + Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1' + type: string + type: object + InstancesSetMinCpuPlatformRequest: + properties: + minCpuPlatform: + description: Minimum cpu/platform this instance should be started at. + type: string + type: object + InstancesSetServiceAccountRequest: + properties: + email: + description: Email address of the service account. + type: string + scopes: + description: The list of scopes to be made available for this service account. + items: + type: string + type: array + type: object + InstancesStartWithEncryptionKeyRequest: + properties: + disks: + description: Array of disks associated with this instance that are protected + with a customer-supplied encryption key. In order to start the instance, + the disk url and its corresponding key must be provided. If the disk is + not protected with a customer-supplied encryption key it should not be + specified. + items: + $ref: '#/components/schemas/CustomerEncryptionKeyProtectedDisk' + type: array + type: object + Int64RangeMatch: + description: HttpRouteRuleMatch criteria for field values that must stay within + the specified integer range. + properties: + rangeEnd: + description: The end of the range (exclusive) in signed long integer format. + format: int64 + type: string + rangeStart: + description: The start of the range (inclusive) in signed long integer format. + format: int64 + type: string + type: object + Interconnect: + description: Represents an Interconnect resource. An Interconnect resource is + a dedicated connection between the GCP network and your on-premises network. + For more information, read the Dedicated Interconnect Overview. + properties: + adminEnabled: + 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 + circuitInfos: + description: '[Output Only] A list of CircuitInfo objects, that describe + the individual circuits in this LAG.' + items: + $ref: '#/components/schemas/InterconnectCircuitInfo' + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customerName: + description: Customer name, to put in the Letter of Authorization as the + party authorized to request a crossconnect. + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + expectedOutages: + description: '[Output Only] A list of outages expected for this Interconnect.' + items: + $ref: '#/components/schemas/InterconnectOutageNotification' + type: array + googleIpAddress: + description: '[Output Only] IP address configured on the Google side of + the Interconnect link. This can be used only for ping tests.' + type: string + googleReferenceId: + description: '[Output Only] Google reference ID to be used when raising + support tickets with Google or otherwise to debug backend connectivity + issues.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + interconnectAttachments: + description: '[Output Only] A list of the URLs of all InterconnectAttachments + configured to use this Interconnect.' + items: + type: string + type: array + interconnectType: + description: 'Type of interconnect, which can take one of the following + values: - PARTNER: A partner-managed interconnection shared between customers + though a partner. - DEDICATED: A dedicated physical interconnection with + the customer. Note that a value IT_PRIVATE has been deprecated in favor + of DEDICATED.' + enum: + - DEDICATED + - IT_PRIVATE + - PARTNER + type: string + kind: + default: compute#interconnect + description: '[Output Only] Type of the resource. Always compute#interconnect + for interconnects.' + type: string + linkType: + description: '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.' + enum: + - LINK_TYPE_ETHERNET_100G_LR + - LINK_TYPE_ETHERNET_10G_LR + type: string + location: + description: URL of the InterconnectLocation object that represents where + this connection is to be provisioned. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + nocContactEmail: + description: 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 Stackdriver logs alerting and Cloud Notifications. + type: string + operationalStatus: + description: '[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. ' + enum: + - OS_ACTIVE + - OS_UNPROVISIONED + type: string + peerIpAddress: + description: '[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.' + type: string + provisionedLinkCount: + description: '[Output Only] Number of links actually provisioned in this + interconnect.' + format: int32 + type: integer + requestedLinkCount: + description: Target number of physical links in the link bundle, as requested + by the customer. + format: int32 + type: integer + satisfiesPzs: + description: '[Output Only] Set to true if the resource satisfies the zone + separation organization policy constraints and false otherwise. Defaults + to false if the field is not present.' + type: boolean + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + state: + description: '[Output Only] The current state of Interconnect functionality, + which can take one of the following values: - ACTIVE: The Interconnect + is valid, turned up and ready to use. Attachments may be provisioned on + this Interconnect. - UNPROVISIONED: The Interconnect has not completed + turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: + The Interconnect is undergoing internal maintenance. No attachments may + be provisioned or updated on this Interconnect. ' + enum: + - ACTIVE + - UNPROVISIONED + type: string + type: object + InterconnectAttachment: + description: Represents an Interconnect Attachment (VLAN) resource. You can + use Interconnect attachments (VLANS) to connect your Virtual Private Cloud + networks to your on-premises networks through an Interconnect. For more information, + read Creating VLAN Attachments. + properties: + adminEnabled: + description: Determines whether this Attachment will carry packets. Not + present for PARTNER_PROVIDER. + type: boolean + bandwidth: + description: 'Provisioned bandwidth capacity for the interconnect attachment. + For attachments of type DEDICATED, the user can set the bandwidth. For + attachments of type PARTNER, the Google Partner that is operating the + interconnect must set the bandwidth. Output only for PARTNER type, mutable + for PARTNER_PROVIDER and DEDICATED, and can take one of the following + values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s + - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - + BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s + - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s ' + enum: + - BPS_100M + - BPS_10G + - BPS_1G + - BPS_200M + - BPS_20G + - BPS_2G + - BPS_300M + - BPS_400M + - BPS_500M + - BPS_50G + - BPS_50M + - BPS_5G + type: string + candidateSubnets: + description: Up to 16 candidate prefixes that can be used to restrict the + allocation of cloudRouterIpAddress and customerRouterIpAddress for this + attachment. All prefixes must be within link-local address space (169.254.0.0/16) + and must be /29 or shorter (/28, /27, etc). Google will attempt to select + an unused /29 from the supplied candidate prefix(es). The request will + fail if all possible /29s are in use on Google's edge. If not supplied, + Google will randomly select an unused /29 from all of link-local space. + items: + type: string + type: array + cloudRouterIpAddress: + description: '[Output Only] IPv4 address + prefix length to be configured + on Cloud Router Interface for this interconnect attachment.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customerRouterIpAddress: + description: '[Output Only] IPv4 address + prefix length to be configured + on the customer router subinterface for this interconnect attachment.' + type: string + dataplaneVersion: + description: '[Output Only] Dataplane version for this InterconnectAttachment.' + format: int32 + type: integer + description: + description: An optional description of this resource. + type: string + edgeAvailabilityDomain: + description: 'Desired availability domain for the attachment. Only available + for type PARTNER, at creation time, and can take one of the following + values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 + For improved reliability, customers should configure a pair of attachments, + one per availability domain. The selected availability domain will be + provided to the Partner via the pairing key, so that the provisioned circuit + will lie in the specified domain. If not specified, the value will default + to AVAILABILITY_DOMAIN_ANY.' + enum: + - AVAILABILITY_DOMAIN_1 + - AVAILABILITY_DOMAIN_2 + - AVAILABILITY_DOMAIN_ANY + type: string + encryption: + description: 'Indicates the user-supplied encryption option of this VLAN + attachment (interconnectAttachment). Can only be specified at attachment + creation for PARTNER or DEDICATED attachments. Possible values are: - + NONE - This is the default value, which means that the VLAN attachment + carries unencrypted traffic. VMs are able to send traffic to, or receive + traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries + only encrypted traffic that is encrypted by an IPsec device, such as an + HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic + to, or receive traffic from, such a VLAN attachment. To use *IPsec-encrypted + Cloud Interconnect*, the VLAN attachment must be created with this option. + Not currently available publicly. ' + enum: + - IPSEC + - NONE + type: string + googleReferenceId: + 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 + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + interconnect: + description: URL of the underlying Interconnect object that this attachment's + traffic will traverse through. + type: string + ipsecInternalAddresses: + description: 'A list of URLs of addresses that have been reserved for the + VLAN attachment. Used only for the VLAN attachment that has the encryption + option as IPSEC. The addresses must be regional internal IP address ranges. + When creating an HA VPN gateway over the VLAN attachment, if the attachment + is configured to use a regional internal IP address, then the VPN gateway''s + IP address is allocated from the IP address range specified here. For + example, if the HA VPN gateway''s interface 0 is paired to this VLAN attachment, + then a regional internal IP address for the VPN gateway interface 0 will + be allocated from the IP address specified for this VLAN attachment. If + this field is not specified when creating the VLAN attachment, then later + on when creating an HA VPN gateway on this VLAN attachment, the HA VPN + gateway''s IP address is allocated from the regional external IP address + pool. Not currently available publicly. ' + items: + type: string + type: array + kind: + default: compute#interconnectAttachment + description: '[Output Only] Type of the resource. Always compute#interconnectAttachment + for interconnect attachments.' + type: string + mtu: + description: Maximum Transmission Unit (MTU), in bytes, of packets passing + through this interconnect attachment. Only 1440 and 1500 are allowed. + If not specified, the value will default to 1440. + format: int32 + type: integer + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + operationalStatus: + description: '[Output Only] The current status of whether or not this interconnect + attachment is functional, which can take one of the following values: + - OS_ACTIVE: The attachment has been turned up and is ready to use. - + OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup + is not complete. ' + enum: + - OS_ACTIVE + - OS_UNPROVISIONED + type: string + pairingKey: + description: '[Output only for type PARTNER. Input only for PARTNER_PROVIDER. + Not present for DEDICATED]. The opaque identifier of an PARTNER attachment + used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"' + type: string + partnerAsn: + description: Optional BGP ASN for the router supplied by a Layer 3 Partner + if they configured BGP on behalf of the customer. Output only for PARTNER + type, input only for PARTNER_PROVIDER, not available for DEDICATED. + format: int64 + type: string + partnerMetadata: + $ref: '#/components/schemas/InterconnectAttachmentPartnerMetadata' + description: Informational metadata about Partner attachments from Partners + to display to customers. Output only for for PARTNER type, mutable for + PARTNER_PROVIDER, not available for DEDICATED. + privateInterconnectInfo: + $ref: '#/components/schemas/InterconnectAttachmentPrivateInfo' + description: '[Output Only] Information specific to an InterconnectAttachment. + This property is populated if the interconnect that this is attached to + is of type DEDICATED.' + region: + description: '[Output Only] URL of the region where the regional interconnect + attachment resides. You must specify this field as part of the HTTP request + URL. It is not settable as a field in the request body.' + type: string + router: + description: URL of the Cloud Router to be used for dynamic routing. This + router must be in the same region as this InterconnectAttachment. The + InterconnectAttachment will automatically connect the Interconnect to + the network & region within which the Cloud Router is configured. + type: string + satisfiesPzs: + description: '[Output Only] Set to true if the resource satisfies the zone + separation organization policy constraints and false otherwise. Defaults + to false if the field is not present.' + type: boolean + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + state: + description: '[Output Only] The current state of this attachment''s functionality. + Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, + PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values + PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used + for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state + can take one of the following values: - ACTIVE: The attachment has been + turned up and is ready to use. - UNPROVISIONED: The attachment is not + ready to use yet, because turnup is not complete. - PENDING_PARTNER: A + newly-created PARTNER attachment that has not yet been configured on the + Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the + process of provisioning after a PARTNER_PROVIDER attachment was created + that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER + attachment that is waiting for a customer to activate it. - DEFUNCT: The + attachment was deleted externally and is no longer functional. This could + be because the associated Interconnect was removed, or because the other + side of a Partner attachment was deleted. ' + enum: + - ACTIVE + - DEFUNCT + - PARTNER_REQUEST_RECEIVED + - PENDING_CUSTOMER + - PENDING_PARTNER + - STATE_UNSPECIFIED + - UNPROVISIONED + type: string + type: + description: 'The type of interconnect attachment this is, which can take + one of the following values: - DEDICATED: an attachment to a Dedicated + Interconnect. - PARTNER: an attachment to a Partner Interconnect, created + by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, + created by the partner. ' + enum: + - DEDICATED + - PARTNER + - PARTNER_PROVIDER + type: string + vlanTag8021q: + description: The IEEE 802.1Q VLAN tag for this attachment, in the range + 2-4094. Only specified at creation time. + format: int32 + type: integer + type: object + InterconnectAttachmentAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/InterconnectAttachmentsScopedList' + description: Name of the scope containing this set of interconnect attachments. + description: A list of InterconnectAttachmentsScopedList resources. + type: object + kind: + default: compute#interconnectAttachmentAggregatedList + description: '[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList + for aggregated lists of interconnect attachments.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectAttachmentList: + description: Response to the list request, and contains a list of interconnect + attachments. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InterconnectAttachment resources. + items: + $ref: '#/components/schemas/InterconnectAttachment' + type: array + kind: + default: compute#interconnectAttachmentList + description: '[Output Only] Type of resource. Always compute#interconnectAttachmentList + for lists of interconnect attachments.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectAttachmentPartnerMetadata: + description: Informational metadata about Partner attachments from Partners + to display to customers. These fields are propagated from PARTNER_PROVIDER + attachments to their corresponding PARTNER attachments. + properties: + interconnectName: + description: Plain text name of the Interconnect this attachment is connected + to, as displayed in the Partner's portal. For instance "Chicago 1". This + value may be validated to match approved Partner values. + type: string + partnerName: + description: Plain text name of the Partner providing this attachment. This + value may be validated to match approved Partner values. + type: string + portalUrl: + description: URL of the Partner's portal for this Attachment. Partners may + customise this to be a deep link to the specific resource on the Partner + portal. This value may be validated to match approved Partner values. + type: string + type: object + InterconnectAttachmentPrivateInfo: + description: Information for an interconnect attachment when this belongs to + an interconnect of type DEDICATED. + properties: + tag8021q: + description: '[Output Only] 802.1q encapsulation tag to be used for traffic + between Google and the customer, going to and from this network and region.' + format: uint32 + type: integer + type: object + InterconnectAttachmentsScopedList: + properties: + interconnectAttachments: + description: A list of interconnect attachments contained in this scope. + items: + $ref: '#/components/schemas/InterconnectAttachment' + type: array + warning: + description: Informational warning which replaces the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectCircuitInfo: + description: Describes a single physical circuit between the Customer and Google. + CircuitInfo objects are created by Google, so all fields are output only. + properties: + customerDemarcId: + description: Customer-side demarc ID for this circuit. + type: string + googleCircuitId: + description: Google-assigned unique ID for this circuit. Assigned at circuit + turn-up. + type: string + googleDemarcId: + description: Google-side demarc ID for this circuit. Assigned at circuit + turn-up and provided by Google to the customer in the LOA. + type: string + type: object + InterconnectDiagnostics: + description: Diagnostics information about interconnect, contains detailed and + current technical information about Google's side of the connection. + properties: + arpCaches: + description: 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. + items: + $ref: '#/components/schemas/InterconnectDiagnosticsARPEntry' + type: array + links: + description: A list of InterconnectDiagnostics.LinkStatus objects, describing + the status for each link on the Interconnect. + items: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkStatus' + type: array + macAddress: + description: The MAC address of the Interconnect's bundle interface. + type: string + type: object + InterconnectDiagnosticsARPEntry: + description: Describing the ARP neighbor entries seen on this link + properties: + ipAddress: + description: The IP address of this ARP neighbor. + type: string + macAddress: + description: The MAC address of this ARP neighbor. + type: string + type: object + InterconnectDiagnosticsLinkLACPStatus: + properties: + googleSystemId: + description: System ID of the port on Google's side of the LACP exchange. + type: string + neighborSystemId: + description: System ID of the port on the neighbor's side of the LACP exchange. + type: string + state: + description: '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. ' + enum: + - ACTIVE + - DETACHED + type: string + type: object + InterconnectDiagnosticsLinkOpticalPower: + properties: + state: + description: '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. ' + enum: + - HIGH_ALARM + - HIGH_WARNING + - LOW_ALARM + - LOW_WARNING + - OK + type: string + value: + description: Value of the current receiving or transmitting optical power, + read in dBm. Take a known good optical value, give it a 10% margin and + trigger warnings relative to that value. In general, a -7dBm warning and + a -11dBm alarm are good optical value estimates for most links. + format: float + type: number + type: object + InterconnectDiagnosticsLinkStatus: + properties: + arpCaches: + description: A list of InterconnectDiagnostics.ARPEntry objects, describing + the ARP neighbor entries seen on this link. This will be empty if the + link is bundled + items: + $ref: '#/components/schemas/InterconnectDiagnosticsARPEntry' + type: array + circuitId: + description: The unique ID for this link assigned during turn up by Google. + type: string + googleDemarc: + description: The Demarc address assigned by Google and provided in the LoA. + type: string + lacpStatus: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkLACPStatus' + receivingOpticalPower: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkOpticalPower' + description: An InterconnectDiagnostics.LinkOpticalPower object, describing + the current value and status of the received light level. + transmittingOpticalPower: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkOpticalPower' + description: An InterconnectDiagnostics.LinkOpticalPower object, describing + the current value and status of the transmitted light level. + type: object + InterconnectList: + description: Response to the list request, and contains a list of interconnects. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Interconnect resources. + items: + $ref: '#/components/schemas/Interconnect' + type: array + kind: + default: compute#interconnectList + description: '[Output Only] Type of resource. Always compute#interconnectList + for lists of interconnects.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectLocation: + description: 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. + properties: + address: + description: '[Output Only] The postal address of the Point of Presence, + each line in the address is separated by a newline character.' + type: string + availabilityZone: + 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 + city: + description: '[Output Only] Metropolitan area designator that indicates + which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, + Netherlands".' + type: string + continent: + description: '[Output Only] Continent for this location, which can take + one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA + - SOUTH_AMERICA ' + enum: + - AFRICA + - ASIA_PAC + - C_AFRICA + - C_ASIA_PAC + - C_EUROPE + - C_NORTH_AMERICA + - C_SOUTH_AMERICA + - EUROPE + - NORTH_AMERICA + - SOUTH_AMERICA + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: '[Output Only] An optional description of the resource.' + type: string + facilityProvider: + description: '[Output Only] The name of the provider for this facility (e.g., + EQUINIX).' + type: string + facilityProviderFacilityId: + description: '[Output Only] A provider-assigned Identifier for this facility + (e.g., Ashburn-DC1).' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#interconnectLocation + description: '[Output Only] Type of the resource. Always compute#interconnectLocation + for interconnect locations.' + type: string + name: + description: '[Output Only] Name of the resource.' + type: string + peeringdbFacilityId: + description: '[Output Only] The peeringdb identifier for this facility (corresponding + with a netfac type in peeringdb).' + type: string + regionInfos: + description: '[Output Only] A list of InterconnectLocation.RegionInfo objects, + that describe parameters pertaining to the relation between this InterconnectLocation + and various Google Cloud regions.' + items: + $ref: '#/components/schemas/InterconnectLocationRegionInfo' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of this InterconnectLocation, which + can take one of the following values: - CLOSED: The InterconnectLocation + is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: + The InterconnectLocation is available for provisioning new Interconnects. ' + enum: + - AVAILABLE + - CLOSED + type: string + supportsPzs: + description: '[Output Only] Set to true for locations that support physical + zone separation. Defaults to false if the field is not present.' + type: boolean + type: object + InterconnectLocationList: + description: Response to the list request, and contains a list of interconnect + locations. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InterconnectLocation resources. + items: + $ref: '#/components/schemas/InterconnectLocation' + type: array + kind: + default: compute#interconnectLocationList + description: '[Output Only] Type of resource. Always compute#interconnectLocationList + for lists of interconnect locations.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectLocationRegionInfo: + description: Information about any potential InterconnectAttachments between + an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. + properties: + expectedRttMs: + description: Expected round-trip time in milliseconds, from this InterconnectLocation + to a VM in this region. + format: int64 + type: string + locationPresence: + description: Identifies the network presence of this location. + enum: + - GLOBAL + - LOCAL_REGION + - LP_GLOBAL + - LP_LOCAL_REGION + type: string + region: + description: URL for the region of this location. + type: string + type: object + InterconnectOutageNotification: + description: Description of a planned outage on this Interconnect. + properties: + affectedCircuits: + description: If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side + circuit IDs that will be affected. + items: + type: string + type: array + description: + description: A description about the purpose of the outage. + type: string + endTime: + description: Scheduled end time for the outage (milliseconds since Unix + epoch). + format: int64 + type: string + issueType: + description: 'Form this outage is expected to take, which can take one of + the following values: - OUTAGE: The Interconnect may be completely out + of service for some or all of the specified window. - PARTIAL_OUTAGE: + Some circuits comprising the Interconnect as a whole should remain up, + but with reduced bandwidth. Note that the versions of this enum prefixed + with "IT_" have been deprecated in favor of the unprefixed values.' + enum: + - IT_OUTAGE + - IT_PARTIAL_OUTAGE + - OUTAGE + - PARTIAL_OUTAGE + type: string + name: + description: Unique identifier for this outage notification. + type: string + source: + description: 'The party that generated this notification, which can take + the following value: - GOOGLE: this notification as generated by Google. + Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.' + enum: + - GOOGLE + - NSRC_GOOGLE + type: string + startTime: + description: Scheduled start time for the outage (milliseconds since Unix + epoch). + format: int64 + type: string + state: + description: 'State of this notification, which can take one of the following + values: - ACTIVE: This outage notification is active. The event could + be in the past, present, or future. See start_time and end_time for scheduling. + - CANCELLED: The outage associated with this notification was cancelled + before the outage was due to start. - COMPLETED: The outage associated + with this notification is complete. Note that the versions of this enum + prefixed with "NS_" have been deprecated in favor of the unprefixed values.' + enum: + - ACTIVE + - CANCELLED + - COMPLETED + - NS_ACTIVE + - NS_CANCELED + type: string + type: object + InterconnectsGetDiagnosticsResponse: + description: Response for the InterconnectsGetDiagnosticsRequest. + properties: + result: + $ref: '#/components/schemas/InterconnectDiagnostics' + 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. ' + properties: + chargesUseFee: + description: '[Output Only] Deprecated. This field no longer reflects whether + a license charges a usage fee.' + type: boolean + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional textual description of the resource; provided by + the client when the resource is created. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#license + description: '[Output Only] Type of resource. Always compute#license for + licenses.' + type: string + licenseCode: + description: '[Output Only] The unique code used to attach this license + to images, snapshots, and disks.' + format: uint64 + type: string + name: + description: Name of the resource. 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 + resourceRequirements: + $ref: '#/components/schemas/LicenseResourceRequirements' + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + transferable: + description: If false, licenses will not be copied from the source resource + when creating an image from a disk, disk from snapshot, or snapshot from + disk. + type: boolean + type: object + LicenseCode: + description: 'Represents a License Code resource. A License Code is a unique + identifier used to represent a license resource. *Caution* This resource is + intended for use only by third-party partners who are creating Cloud Marketplace + images. ' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: '[Output Only] Description of this License Code.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#licenseCode + description: '[Output Only] Type of resource. Always compute#licenseCode + for licenses.' + type: string + licenseAlias: + description: '[Output Only] URL and description aliases of Licenses with + the same License Code.' + items: + $ref: '#/components/schemas/LicenseCodeLicenseAlias' + type: array + name: + description: '[Output Only] Name of the resource. The name is 1-20 characters + long and must be a valid 64 bit integer.' + pattern: '[0-9]{0,20}?' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + state: + description: '[Output Only] Current state of this License Code.' + enum: + - DISABLED + - ENABLED + - RESTRICTED + - STATE_UNSPECIFIED + - TERMINATED + type: string + transferable: + description: '[Output Only] If true, the license will remain attached when + creating images or snapshots from disks. Otherwise, the license is not + transferred.' + type: boolean + type: object + LicenseCodeLicenseAlias: + properties: + description: + description: '[Output Only] Description of this License Code.' + type: string + selfLink: + description: '[Output Only] URL of license corresponding to this License + Code.' + type: string + type: object + LicenseResourceCommitment: + description: Commitment for a particular license resource. + properties: + amount: + description: The number of licenses purchased. + format: int64 + type: string + coresPerLicense: + description: Specifies the core range of the instance for which this license + applies. + type: string + license: + description: Any applicable license URI. + type: string + type: object + LicenseResourceRequirements: + properties: + minGuestCpuCount: + description: Minimum number of guest cpus required to use the Instance. + Enforced at Instance creation and Instance start. + format: int32 + type: integer + minMemoryMb: + description: Minimum memory required to use the Instance. Enforced at Instance + creation and Instance start. + format: int32 + type: integer + type: object + LicensesListResponse: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of License resources. + items: + $ref: '#/components/schemas/License' + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + LocalDisk: + properties: + diskCount: + description: Specifies the number of such disks. + format: int32 + type: integer + diskSizeGb: + description: Specifies the size of the disk in base-2 GB. + format: int32 + type: integer + diskType: + description: 'Specifies the desired disk type on the node. This disk type + must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, + this should be the name of the disk type and not its URL.' + type: string + type: object + LocationPolicy: + description: Configuration for location policy among multiple possible locations + (e.g. preferences for zone selection among zones in a single region). + properties: + locations: + additionalProperties: + $ref: '#/components/schemas/LocationPolicyLocation' + description: Location configurations mapped by location name. Currently + only zone names are supported and must be represented as valid internal + URLs, such as zones/us-central1-a. + type: object + type: object + LocationPolicyLocation: + properties: + preference: + description: 'Preference for a given location: ALLOW or DENY.' + enum: + - ALLOW + - DENY + - PREFERENCE_UNSPECIFIED + type: string + type: object + LogConfig: + description: This is deprecated and has no effect. Do not use. + properties: + cloudAudit: + $ref: '#/components/schemas/LogConfigCloudAuditOptions' + description: This is deprecated and has no effect. Do not use. + counter: + $ref: '#/components/schemas/LogConfigCounterOptions' + description: This is deprecated and has no effect. Do not use. + dataAccess: + $ref: '#/components/schemas/LogConfigDataAccessOptions' + description: This is deprecated and has no effect. Do not use. + type: object + LogConfigCloudAuditOptions: + description: This is deprecated and has no effect. Do not use. + properties: + authorizationLoggingOptions: + $ref: '#/components/schemas/AuthorizationLoggingOptions' + description: This is deprecated and has no effect. Do not use. + logName: + description: This is deprecated and has no effect. Do not use. + enum: + - ADMIN_ACTIVITY + - DATA_ACCESS + - UNSPECIFIED_LOG_NAME + type: string + type: object + LogConfigCounterOptions: + description: This is deprecated and has no effect. Do not use. + properties: + customFields: + description: This is deprecated and has no effect. Do not use. + items: + $ref: '#/components/schemas/LogConfigCounterOptionsCustomField' + type: array + field: + description: This is deprecated and has no effect. Do not use. + type: string + metric: + description: This is deprecated and has no effect. Do not use. + type: string + type: object + LogConfigCounterOptionsCustomField: + description: This is deprecated and has no effect. Do not use. + properties: + name: + description: This is deprecated and has no effect. Do not use. + type: string + value: + description: This is deprecated and has no effect. Do not use. + type: string + type: object + LogConfigDataAccessOptions: + description: This is deprecated and has no effect. Do not use. + properties: + logMode: + description: This is deprecated and has no effect. Do not use. + enum: + - LOG_FAIL_CLOSED + - LOG_MODE_UNSPECIFIED + type: string + type: object + MachineType: + description: Represents a Machine Type resource. You can use specific machine + types for your VM instances based on performance and pricing requirements. + For more information, read Machine Types. + properties: + accelerators: + description: '[Output Only] A list of accelerator configurations assigned + to this machine type.' + items: + properties: + guestAcceleratorCount: + description: Number of accelerator cards exposed to the guest. + format: int32 + type: integer + guestAcceleratorType: + description: The accelerator type resource name, not a full URL, e.g. + 'nvidia-tesla-k80'. + type: string + type: object + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + machine type. Only applicable if the machine type is unavailable.' + description: + description: '[Output Only] An optional textual description of the resource.' + type: string + guestCpus: + description: '[Output Only] The number of virtual CPUs that are available + to the instance.' + format: int32 + type: integer + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + imageSpaceGb: + description: '[Deprecated] This property is deprecated and will never be + populated with any relevant values.' + format: int32 + type: integer + isSharedCpu: + description: '[Output Only] Whether this machine type has a shared CPU. + See Shared-core machine types for more information.' + type: boolean + kind: + default: compute#machineType + description: '[Output Only] The type of the resource. Always compute#machineType + for machine types.' + type: string + maximumPersistentDisks: + description: '[Output Only] Maximum persistent disks allowed.' + format: int32 + type: integer + maximumPersistentDisksSizeGb: + description: '[Output Only] Maximum total persistent disks size (GB) allowed.' + format: int64 + type: string + memoryMb: + description: '[Output Only] The amount of physical memory available to the + instance, defined in MB.' + format: int32 + type: integer + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + scratchDisks: + description: '[Output Only] A list of extended scratch disks assigned to + the instance.' + items: + properties: + diskGb: + description: Size of the scratch disk, defined in GB. + format: int32 + type: integer + type: object + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + zone: + description: '[Output Only] The name of the zone where the machine type + resides, such as us-central1-a.' + type: string + type: object + MachineTypeAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/MachineTypesScopedList' + description: '[Output Only] Name of the scope containing this set of machine + types.' + description: A list of MachineTypesScopedList resources. + type: object + kind: + default: compute#machineTypeAggregatedList + description: '[Output Only] Type of resource. Always compute#machineTypeAggregatedList + for aggregated lists of machine types.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + MachineTypeList: + description: Contains a list of machine types. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of MachineType resources. + items: + $ref: '#/components/schemas/MachineType' + type: array + kind: + default: compute#machineTypeList + description: '[Output Only] Type of resource. Always compute#machineTypeList + for lists of machine types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + MachineTypesScopedList: + properties: + machineTypes: + description: '[Output Only] A list of machine types contained in this scope.' + items: + $ref: '#/components/schemas/MachineType' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + machine types 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ManagedInstance: + description: A Managed Instance resource. + properties: + currentAction: + description: '[Output Only] The current action that the managed instance + group has scheduled for the instance. Possible values: - NONE The instance + is running, and the managed instance group does not have any scheduled + actions for this instance. - CREATING The managed instance group is creating + this instance. If the group fails to create this instance, it will try + again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance + group is attempting to create this instance only once. If the group fails + to create this instance, it does not try again and the group''s targetSize + value is decreased instead. - RECREATING The managed instance group is + recreating this instance. - DELETING The managed instance group is permanently + deleting this instance. - ABANDONING The managed instance group is abandoning + this instance. The instance will be removed from the instance group and + from any target pools that are associated with this group. - RESTARTING + The managed instance group is restarting the instance. - REFRESHING The + managed instance group is applying configuration changes to the instance + without stopping it. For example, the group can update the target pool + list for an instance without stopping that instance. - VERIFYING The managed + instance group has created the instance and it is in the process of being + verified. ' + enum: + - ABANDONING + - CREATING + - CREATING_WITHOUT_RETRIES + - DELETING + - NONE + - RECREATING + - REFRESHING + - RESTARTING + - VERIFYING + type: string + id: + description: '[Output only] The unique identifier for this resource. This + field is empty when instance does not exist.' + format: uint64 + type: string + instance: + description: '[Output Only] The URL of the instance. The URL can exist even + if the instance has not yet been created.' + type: string + instanceHealth: + description: '[Output Only] Health state of the instance per health-check.' + items: + $ref: '#/components/schemas/ManagedInstanceInstanceHealth' + type: array + instanceStatus: + description: '[Output Only] The status of the instance. This field is empty + when the instance does not exist.' + enum: + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED + type: string + lastAttempt: + $ref: '#/components/schemas/ManagedInstanceLastAttempt' + description: '[Output Only] Information about the last attempt to create + or delete the instance.' + preservedStateFromConfig: + $ref: '#/components/schemas/PreservedState' + description: '[Output Only] Preserved state applied from per-instance config + for this instance.' + preservedStateFromPolicy: + $ref: '#/components/schemas/PreservedState' + description: '[Output Only] Preserved state generated based on stateful + policy for this instance.' + version: + $ref: '#/components/schemas/ManagedInstanceVersion' + description: '[Output Only] Intended version of this instance.' + type: object + ManagedInstanceInstanceHealth: + properties: + detailedHealthState: + description: '[Output Only] The current detailed instance health state.' + enum: + - DRAINING + - HEALTHY + - TIMEOUT + - UNHEALTHY + - UNKNOWN + type: string + healthCheck: + description: '[Output Only] The URL for the health check that verifies whether + the instance is healthy.' + type: string + type: object + ManagedInstanceLastAttempt: + properties: + errors: + description: '[Output Only] Encountered errors during the last attempt to + create or delete the instance.' + 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 + 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 + ManagedInstanceVersion: + properties: + instanceTemplate: + description: '[Output Only] The intended template of the instance. This + field is empty when current_action is one of { DELETING, ABANDONING }.' + type: string + name: + description: '[Output Only] Name of the version.' + type: string + type: object + Metadata: + description: A metadata key/value entry. + properties: + fingerprint: + description: Specifies a fingerprint for this request, which is essentially + a hash of the metadata's contents and used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update metadata. You must always provide an + up-to-date fingerprint hash in order to update or change metadata, otherwise + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the resource. + format: byte + type: string + items: + description: Array of key/value pairs. The total size of all keys and values + must be less than 512 KB. + items: + description: Metadata + properties: + key: + description: 'Key for the metadata entry. Keys must conform to the + following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in + length. This is reflected as part of a URL in the metadata server. + Additionally, to avoid ambiguity, keys must not conflict with any + other metadata keys for the project.' + pattern: '[a-zA-Z0-9-_]{1,128}' + type: string + value: + description: Value for the metadata entry. These are free-form strings, + and only have meaning as interpreted by the image running in the + instance. The only restriction placed on values is that their size + must be less than or equal to 262144 bytes (256 KiB). + type: string + type: object + type: array + kind: + default: compute#metadata + description: '[Output Only] Type of the resource. Always compute#metadata + for metadata.' + type: string + type: object + MetadataFilter: + description: 'Opaque filter criteria used by loadbalancers to restrict routing + configuration to a limited set of loadbalancing proxies. Proxies and sidecars + involved in loadbalancing would typically present metadata to the loadbalancers + which need to match criteria specified here. If a match takes place, the relevant + configuration is made available to those proxies. For each metadataFilter + in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one + of the filterLabels must match the corresponding label provided in the metadata. + If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels + must match with corresponding labels provided in the metadata. An example + for using metadataFilters would be: if loadbalancing involves Envoys, they + will only receive routing configuration when values in metadataFilters match + values supplied in of their XDS requests to loadbalancers.' + properties: + filterLabels: + description: The list of label value pairs that must match labels in the + provided metadata based on filterMatchCriteria This list must not be empty + and can have at the most 64 entries. + items: + $ref: '#/components/schemas/MetadataFilterLabelMatch' + type: array + filterMatchCriteria: + description: 'Specifies how individual filterLabel matches within the list + of filterLabels contribute towards the overall metadataFilter match. Supported + values are: - MATCH_ANY: At least one of the filterLabels must have a + matching label in the provided metadata. - MATCH_ALL: All filterLabels + must have matching labels in the provided metadata. ' + enum: + - MATCH_ALL + - MATCH_ANY + - NOT_SET + type: string + type: object + MetadataFilterLabelMatch: + description: MetadataFilter label name value pairs that are expected to match + corresponding labels presented as metadata to the loadbalancer. + properties: + name: + description: Name of metadata label. The name can have a maximum length + of 1024 characters and must be at least 1 character long. + type: string + value: + description: The value of the label must match the specified value. value + can have a maximum length of 1024 characters. + type: string + type: object + NamedPort: + description: 'The named port. For example: <"http", 80>.' + properties: + name: + description: The name for this named port. The name must be 1-63 characters + long, and comply with RFC1035. + type: string + port: + description: The port number, which can be a value between 1 and 65535. + format: int32 + type: integer + type: object + Network: + description: Represents a VPC Network resource. Networks connect resources to + each other and to the internet. For more information, read Virtual Private + Cloud (VPC) Network. + properties: + IPv4Range: + 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 + autoCreateSubnetworks: + description: Must be set to create a VPC network. If not set, a legacy network + is created. When set to true, the VPC network is created in auto mode. + When set to false, the VPC network is created in custom mode. An auto + mode VPC network starts with one subnet per region. Each subnet has a + predetermined range as described in Auto mode VPC network IP ranges. For + custom mode VPC networks, you can add subnets using the subnetworks insert + method. + type: boolean + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this field + when you create the resource. + type: string + gatewayIPv4: + description: '[Output Only] The gateway address for default routing out + of the network, selected by GCP.' + pattern: '[0-9]{1,3}(?:\.[0-9]{1,3}){3}' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#network + description: '[Output Only] Type of the resource. Always compute#network + for networks.' + type: string + mtu: + description: Maximum Transmission Unit in bytes. The minimum value for this + field is 1460 and the maximum value is 1500 bytes. If unspecified, defaults + to 1460. + format: int32 + type: integer + name: + description: 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])?`. The first character must be a + lowercase letter, and all following characters (except for the last character) + must be a dash, lowercase letter, or digit. The last character must be + a lowercase letter or digit. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + peerings: + description: '[Output Only] A list of network peerings for the resource.' + items: + $ref: '#/components/schemas/NetworkPeering' + type: array + routingConfig: + $ref: '#/components/schemas/NetworkRoutingConfig' + description: The network-level routing configuration for this network. Used + by Cloud Router to determine what type of network-wide routing behavior + to enforce. + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + subnetworks: + description: '[Output Only] Server-defined fully-qualified URLs for all + subnetworks in this VPC network.' + items: + type: string + type: array + type: object + NetworkEndpoint: + description: The network endpoint. + properties: + annotations: + additionalProperties: + type: string + description: Metadata defined as annotations on the network endpoint. + type: object + fqdn: + description: Optional fully qualified domain name of network endpoint. This + can only be specified when NetworkEndpointGroup.network_endpoint_type + is NON_GCP_FQDN_PORT. + type: string + instance: + description: 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. + type: string + ipAddress: + description: 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. + type: string + port: + description: Optional port number of network endpoint. If not specified, + the defaultPort for the network endpoint group will be used. + format: int32 + type: integer + type: object + NetworkEndpointGroup: + description: Represents a collection of network endpoints. A network endpoint + group (NEG) defines how a set of endpoints should be reached, whether they + are reachable, and where they are located. For more information about using + NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting + up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless + NEGs. + properties: + annotations: + additionalProperties: + type: string + description: Metadata defined as annotations on the network endpoint group. + type: object + appEngine: + $ref: '#/components/schemas/NetworkEndpointGroupAppEngine' + description: Only valid when networkEndpointType is "SERVERLESS". Only one + of cloudRun, appEngine or cloudFunction may be set. + cloudFunction: + $ref: '#/components/schemas/NetworkEndpointGroupCloudFunction' + description: Only valid when networkEndpointType is "SERVERLESS". Only one + of cloudRun, appEngine or cloudFunction may be set. + cloudRun: + $ref: '#/components/schemas/NetworkEndpointGroupCloudRun' + description: Only valid when networkEndpointType is "SERVERLESS". Only one + of cloudRun, appEngine or cloudFunction may be set. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + defaultPort: + description: The default port used if the port number is not specified in + the network endpoint. + format: int32 + type: integer + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#networkEndpointGroup + description: '[Output Only] Type of the resource. Always compute#networkEndpointGroup + for network endpoint group.' + type: string + name: + description: 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. + type: string + network: + description: The URL of the network to which all network endpoints in the + NEG belong. Uses "default" project network if unspecified. + type: string + networkEndpointType: + description: Type of network endpoints in this network endpoint group. Can + be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, + INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + enum: + - GCE_VM_IP + - GCE_VM_IP_PORT + - INTERNET_FQDN_PORT + - INTERNET_IP_PORT + - NON_GCP_PRIVATE_IP_PORT + - SERVERLESS + type: string + region: + description: '[Output Only] The URL of the region where the network endpoint + group is located.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + size: + description: '[Output only] Number of network endpoints in the network endpoint + group.' + format: int32 + type: integer + subnetwork: + description: Optional URL of the subnetwork to which all network endpoints + in the NEG belong. + type: string + zone: + description: '[Output Only] The URL of the zone where the network endpoint + group is located.' + type: string + type: object + NetworkEndpointGroupAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/NetworkEndpointGroupsScopedList' + description: The name of the scope that contains this set of network endpoint + groups. + description: A list of NetworkEndpointGroupsScopedList resources. + type: object + kind: + default: compute#networkEndpointGroupAggregatedList + description: '[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList + for aggregated lists of network endpoint groups.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkEndpointGroupAppEngine: + description: 'Configuration for an App Engine network endpoint group (NEG). + The service is optional, may be provided explicitly or in the URL mask. The + version is optional and can only be provided explicitly or in the URL mask + when service is present. Note: App Engine service must be in the same project + and located in the same region as the Serverless NEG.' + properties: + service: + description: 'Optional serving service. The service name is case-sensitive + and must be 1-63 characters long. Example value: "default", "my-service".' + type: string + urlMask: + description: A template to parse service and version fields from a request + URL. URL mask allows for routing to multiple App Engine services without + having to create multiple Network Endpoint Groups and backend services. + For example, the request URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" + can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". + The URL mask will parse them to { service = "foo1", version = "v1" } and + { service = "foo1", version = "v2" } respectively. + type: string + version: + description: 'Optional serving version. The version name is case-sensitive + and must be 1-100 characters long. Example value: "v1", "v2".' + type: string + type: object + NetworkEndpointGroupCloudFunction: + description: 'Configuration for a Cloud Function network endpoint group (NEG). + The function must be provided explicitly or in the URL mask. Note: Cloud Function + must be in the same project and located in the same region as the Serverless + NEG.' + properties: + function: + description: 'A user-defined name of the Cloud Function. The function name + is case-sensitive and must be 1-63 characters long. Example value: "func1".' + type: string + urlMask: + description: A template to parse function field from a request URL. URL + mask allows for routing to multiple Cloud Functions without having to + create multiple Network Endpoint Groups and backend services. For example, + request URLs " mydomain.com/function1" and "mydomain.com/function2" can + be backed by the same Serverless NEG with URL mask "/". The URL mask will + parse them to { function = "function1" } and { function = "function2" + } respectively. + type: string + type: object + NetworkEndpointGroupCloudRun: + description: 'Configuration for a Cloud Run network endpoint group (NEG). The + service must be provided explicitly or in the URL mask. The tag is optional, + may be provided explicitly or in the URL mask. Note: Cloud Run service must + be in the same project and located in the same region as the Serverless NEG.' + properties: + service: + description: 'Cloud Run service is the main resource of Cloud Run. The service + must be 1-63 characters long, and comply with RFC1035. Example value: + "run-service".' + type: string + tag: + description: 'Optional Cloud Run tag represents the "named-revision" to + provide additional fine-grained traffic routing information. The tag must + be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010".' + type: string + urlMask: + description: A template to parse service and tag fields from a request URL. + URL mask allows for routing to multiple Run services without having to + create multiple network endpoint groups and backend services. For example, + request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be + backed by the same Serverless Network Endpoint Group (NEG) with URL mask + ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" + } and { service="bar2", tag="foo2" } respectively. + type: string + type: object + NetworkEndpointGroupList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NetworkEndpointGroup resources. + items: + $ref: '#/components/schemas/NetworkEndpointGroup' + type: array + kind: + default: compute#networkEndpointGroupList + description: '[Output Only] The resource type, which is always compute#networkEndpointGroupList + for network endpoint 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkEndpointGroupsAttachEndpointsRequest: + properties: + networkEndpoints: + description: The list of network endpoints to be attached. + items: + $ref: '#/components/schemas/NetworkEndpoint' + type: array + type: object + NetworkEndpointGroupsDetachEndpointsRequest: + properties: + networkEndpoints: + description: The list of network endpoints to be detached. + items: + $ref: '#/components/schemas/NetworkEndpoint' + type: array + type: object + NetworkEndpointGroupsListEndpointsRequest: + properties: + healthStatus: + description: Optional query parameter for showing the health status of each + network endpoint. Valid options are SKIP or SHOW. If you don't specify + this parameter, the health status of network endpoints will not be provided. + enum: + - SHOW + - SKIP + type: string + type: object + NetworkEndpointGroupsListNetworkEndpoints: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NetworkEndpointWithHealthStatus resources. + items: + $ref: '#/components/schemas/NetworkEndpointWithHealthStatus' + type: array + kind: + default: compute#networkEndpointGroupsListNetworkEndpoints + description: '[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints + for the list of network endpoints in the specified network endpoint group.' + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkEndpointGroupsScopedList: + properties: + networkEndpointGroups: + description: '[Output Only] The list of network endpoint groups that are + contained in this scope.' + items: + $ref: '#/components/schemas/NetworkEndpointGroup' + type: array + warning: + description: '[Output Only] An informational warning that replaces the list + of network endpoint groups 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkEndpointWithHealthStatus: + properties: + healths: + description: '[Output only] The health status of network endpoint;' + items: + $ref: '#/components/schemas/HealthStatusForNetworkEndpoint' + type: array + networkEndpoint: + $ref: '#/components/schemas/NetworkEndpoint' + description: '[Output only] The network endpoint;' + type: object + NetworkInterface: + description: A network interface resource attached to an instance. + properties: + accessConfigs: + description: An array of configurations for this interface. Currently, only + one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs + specified, then this instance will have no external internet access. + items: + $ref: '#/components/schemas/AccessConfig' + type: array + aliasIpRanges: + description: An array of alias IP ranges for this network interface. You + can only specify this field for network interfaces in VPC networks. + items: + $ref: '#/components/schemas/AliasIpRange' + type: array + fingerprint: + description: Fingerprint hash of contents stored in this network interface. + This field will be ignored when inserting an Instance or adding a NetworkInterface. + An up-to-date fingerprint must be provided in order to update the NetworkInterface. + The request will fail with error 400 Bad Request if the fingerprint is + not provided, or 412 Precondition Failed if the fingerprint is out of + date. + format: byte + type: string + ipv6AccessConfigs: + description: An array of IPv6 access configurations for this interface. + Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If + there is no ipv6AccessConfig specified, then this instance will have no + external IPv6 Internet access. + items: + $ref: '#/components/schemas/AccessConfig' + type: array + ipv6AccessType: + description: '[Output Only] One of EXTERNAL, INTERNAL to indicate whether + the IP can be accessed from the Internet. This field is always inherited + from its subnetwork. Valid only if stackType is IPV4_IPV6.' + enum: + - EXTERNAL + - UNSPECIFIED_IPV6_ACCESS_TYPE + type: string + ipv6Address: + description: '[Output Only] An IPv6 internal network address for this network + interface.' + type: string + kind: + default: compute#networkInterface + description: '[Output Only] Type of the resource. Always compute#networkInterface + for network interfaces.' + type: string + name: + description: '[Output Only] The name of the network interface, which is + generated by the server. For network devices, these are eth0, eth1, etc.' + type: string + network: + description: 'URL of the network resource for this instance. When creating + an instance, if neither the network nor the subnetwork is specified, the + default network global/networks/default is used; if the network is not + specified but the subnetwork is specified, the network is inferred. If + you specify this property, you can specify the network as a full or partial + URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ + network - projects/project/global/networks/network - global/networks/default ' + type: string + networkIP: + description: An IPv4 internal IP address to assign to the instance for this + network interface. If not specified by the user, an unused internal IP + is assigned by the system. + type: string + nicType: + description: The type of vNIC to be used on this interface. This may be + gVNIC or VirtioNet. + enum: + - GVNIC + - UNSPECIFIED_NIC_TYPE + - VIRTIO_NET + type: string + queueCount: + description: The networking queue count that's specified by users for the + network interface. Both Rx and Tx queues will be set to this number. It'll + be empty if not specified by the users. + format: int32 + type: integer + stackType: + description: The stack type for this network interface to identify whether + the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be + used. This field can be both set at instance creation and update network + interface operations. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - UNSPECIFIED_STACK_TYPE + type: string + subnetwork: + description: 'The URL of the Subnetwork resource for this instance. If the + network resource is in legacy mode, do not specify this field. If the + network is in auto subnet mode, specifying the subnetwork is optional. + If the network is in custom subnet mode, specifying the subnetwork is + required. If you specify this field, you can specify the subnetwork as + a full or partial URL. For example, the following are all valid URLs: + - https://www.googleapis.com/compute/v1/projects/project/regions/region + /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ' + type: string + type: object + NetworkList: + description: Contains a list of networks. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Network resources. + items: + $ref: '#/components/schemas/Network' + type: array + kind: + default: compute#networkList + description: '[Output Only] Type of resource. Always compute#networkList + for lists of networks.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkPeering: + description: A network peering attached to a network resource. The message includes + the peering name, peer network, peering state, and a flag indicating whether + Google Compute Engine should automatically create routes for the peering. + properties: + autoCreateRoutes: + description: This field will be deprecated soon. Use the exchange_subnet_routes + field instead. Indicates whether full mesh connectivity is created and + managed automatically between peered networks. Currently this field should + always be true since Google Compute Engine will automatically create and + manage subnetwork routes between two networks when peering state is ACTIVE. + type: boolean + exchangeSubnetRoutes: + description: Indicates whether full mesh connectivity is created and managed + automatically between peered networks. Currently this field should always + be true since Google Compute Engine will automatically create and manage + subnetwork routes between two networks when peering state is ACTIVE. + type: boolean + exportCustomRoutes: + description: Whether to export the custom routes to peer network. + type: boolean + exportSubnetRoutesWithPublicIp: + description: Whether subnet routes with public IP range are exported. The + default value is true, all subnet routes are exported. IPv4 special-use + ranges are always exported to peers and are not controlled by this field. + type: boolean + importCustomRoutes: + description: Whether to import the custom routes from peer network. + type: boolean + importSubnetRoutesWithPublicIp: + description: Whether subnet routes with public IP range are imported. The + default value is false. IPv4 special-use ranges are always imported from + peers and are not controlled by this field. + type: boolean + name: + description: Name of this peering. Provided by the client when the peering + is created. The name must comply with RFC1035. Specifically, the name + must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. + The first character must be a lowercase letter, and all the following + characters must be a dash, lowercase letter, or digit, except the last + character, which cannot be a dash. + type: string + network: + description: The URL of the peer network. It can be either full URL or partial + URL. The peer network may belong to a different project. If the partial + URL does not contain project, it is assumed that the peer network is in + the same project as the current network. + type: string + peerMtu: + description: Maximum Transmission Unit in bytes. + format: int32 + type: integer + state: + description: '[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. + The peering is `ACTIVE` when there''s a matching configuration in the + peer network.' + enum: + - ACTIVE + - INACTIVE + type: string + stateDetails: + description: '[Output Only] Details about the current state of the peering.' + type: string + type: object + NetworkRoutingConfig: + description: A routing configuration attached to a network resource. The message + includes the list of routers associated with the network, and a flag indicating + the type of routing behavior to enforce network-wide. + properties: + routingMode: + description: The network-wide routing mode to use. If set to REGIONAL, this + network's Cloud Routers will only advertise routes with subnets of this + network in the same region as the router. If set to GLOBAL, this network's + Cloud Routers will advertise routes with all subnets of this network, + across regions. + enum: + - GLOBAL + - REGIONAL + type: string + type: object + NetworksAddPeeringRequest: + properties: + autoCreateRoutes: + description: This field will be deprecated soon. Use exchange_subnet_routes + in network_peering instead. Indicates whether full mesh connectivity is + created and managed automatically between peered networks. Currently this + field should always be true since Google Compute Engine will automatically + create and manage subnetwork routes between two networks when peering + state is ACTIVE. + type: boolean + name: + description: Name of the peering, which should conform to RFC1035. + type: string + networkPeering: + $ref: '#/components/schemas/NetworkPeering' + description: Network peering parameters. In order to specify route policies + for peering using import and export custom routes, you must specify all + peering related parameters (name, peer network, exchange_subnet_routes) + in the network_peering field. The corresponding fields in NetworksAddPeeringRequest + will be deprecated soon. + peerNetwork: + description: URL of the peer network. It can be either full URL or partial + URL. The peer network may belong to a different project. If the partial + URL does not contain project, it is assumed that the peer network is in + the same project as the current network. + type: string + type: object + NetworksGetEffectiveFirewallsResponse: + properties: + firewallPolicys: + description: Effective firewalls from firewall policy. + items: + $ref: '#/components/schemas/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy' + type: array + firewalls: + description: Effective firewalls on the network. + items: + $ref: '#/components/schemas/Firewall' + type: array + type: object + NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy: + properties: + displayName: + description: '[Output Only] Deprecated, please use short name instead. The + display name of the firewall policy.' + type: string + name: + description: '[Output Only] The name of the firewall policy.' + type: string + rules: + description: The rules that apply to the network. + items: + $ref: '#/components/schemas/FirewallPolicyRule' + type: array + shortName: + description: '[Output Only] The short name of the firewall policy.' + type: string + type: + description: '[Output Only] The type of the firewall policy.' + enum: + - HIERARCHY + - NETWORK + - UNSPECIFIED + type: string + type: object + NetworksRemovePeeringRequest: + properties: + name: + description: Name of the peering, which should conform to RFC1035. + type: string + type: object + NetworksUpdatePeeringRequest: + properties: + networkPeering: + $ref: '#/components/schemas/NetworkPeering' + type: object + NodeGroup: + description: Represents a sole-tenant Node Group resource. A sole-tenant node + is a physical server that is dedicated to hosting VM instances only for your + specific project. Use sole-tenant nodes to keep your instances physically + separated from instances in other projects, or to group your instances together + on the same host hardware. For more information, read Sole-tenant nodes. + properties: + autoscalingPolicy: + $ref: '#/components/schemas/NodeGroupAutoscalingPolicy' + description: Specifies how autoscaling should behave. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#nodeGroup + description: '[Output Only] The type of the resource. Always compute#nodeGroup + for node group.' + type: string + locationHint: + description: An opaque location hint used to place the Node close to other + resources. This field is for use by internal tools that use the public + API. The location hint here on the NodeGroup overrides any location_hint + present in the NodeTemplate. + type: string + maintenancePolicy: + description: 'Specifies how to handle instances when a node in the group + undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. + The default value is DEFAULT. For more information, see Maintenance policies.' + enum: + - DEFAULT + - MAINTENANCE_POLICY_UNSPECIFIED + - MIGRATE_WITHIN_NODE_GROUP + - RESTART_IN_PLACE + type: string + maintenanceWindow: + $ref: '#/components/schemas/NodeGroupMaintenanceWindow' + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + nodeTemplate: + description: URL of the node template to create the node group from. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + size: + description: '[Output Only] The total number of nodes in the node group.' + format: int32 + type: integer + status: + enum: + - CREATING + - DELETING + - INVALID + - READY + type: string + zone: + description: '[Output Only] The name of the zone where the node group resides, + such as us-central1-a.' + type: string + type: object + NodeGroupAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/NodeGroupsScopedList' + description: '[Output Only] Name of the scope containing this set of node + groups.' + description: A list of NodeGroupsScopedList resources. + type: object + kind: + default: compute#nodeGroupAggregatedList + description: '[Output Only] Type of resource.Always compute#nodeGroupAggregatedList + for aggregated lists of node groups.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeGroupAutoscalingPolicy: + properties: + maxNodes: + description: The maximum number of nodes that the group should have. Must + be set if autoscaling is enabled. Maximum value allowed is 100. + format: int32 + type: integer + minNodes: + description: The minimum number of nodes that the group should have. + format: int32 + type: integer + mode: + description: 'The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. + For more information, see Autoscaler modes.' + enum: + - MODE_UNSPECIFIED + - false + - true + - ONLY_SCALE_OUT + type: string + type: object + NodeGroupList: + description: Contains a list of nodeGroups. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NodeGroup resources. + items: + $ref: '#/components/schemas/NodeGroup' + type: array + kind: + default: compute#nodeGroupList + description: '[Output Only] Type of resource.Always compute#nodeGroupList + for lists of node groups.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeGroupMaintenanceWindow: + description: Time window specified for daily maintenance operations. GCE's internal + maintenance will be performed within this window. + properties: + maintenanceDuration: + $ref: '#/components/schemas/Duration' + description: '[Output only] A predetermined duration for the window, automatically + chosen to be the smallest possible in the given scenario.' + startTime: + description: Start time of the window. This must be in UTC format that resolves + to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both + 13:00-5 and 08:00 are valid. + type: string + type: object + NodeGroupNode: + properties: + accelerators: + description: Accelerators for this node. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + cpuOvercommitType: + description: CPU overcommit. + enum: + - CPU_OVERCOMMIT_TYPE_UNSPECIFIED + - ENABLED + - NONE + type: string + disks: + description: Local disk configurations. + items: + $ref: '#/components/schemas/LocalDisk' + type: array + instances: + description: Instances scheduled on this node. + items: + type: string + type: array + name: + description: The name of the node. + type: string + nodeType: + description: The type of this node. + type: string + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + serverBinding: + $ref: '#/components/schemas/ServerBinding' + description: Binding properties for the physical server. + serverId: + description: Server ID associated with this node. + type: string + status: + enum: + - CREATING + - DELETING + - INVALID + - READY + - REPAIRING + type: string + type: object + NodeGroupsAddNodesRequest: + properties: + additionalNodeCount: + description: Count of additional nodes to be added to the node group. + format: int32 + type: integer + type: object + NodeGroupsDeleteNodesRequest: + properties: + nodes: + description: Names of the nodes to delete. + items: + type: string + type: array + type: object + NodeGroupsListNodes: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Node resources. + items: + $ref: '#/components/schemas/NodeGroupNode' + type: array + kind: + default: compute#nodeGroupsListNodes + description: '[Output Only] The resource type, which is always compute.nodeGroupsListNodes + for the list of nodes in the specified node group.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeGroupsScopedList: + properties: + nodeGroups: + description: '[Output Only] A list of node groups contained in this scope.' + items: + $ref: '#/components/schemas/NodeGroup' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + nodeGroup 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeGroupsSetNodeTemplateRequest: + properties: + nodeTemplate: + description: Full or partial URL of the node template resource to be updated + for this node group. + type: string + type: object + NodeTemplate: + description: Represent a sole-tenant Node Template resource. You can use a template + to define properties for nodes in a node group. For more information, read + Creating node groups and instances. + properties: + accelerators: + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + cpuOvercommitType: + description: CPU overcommit. + enum: + - CPU_OVERCOMMIT_TYPE_UNSPECIFIED + - ENABLED + - NONE + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + disks: + items: + $ref: '#/components/schemas/LocalDisk' + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#nodeTemplate + description: '[Output Only] The type of the resource. Always compute#nodeTemplate + for node templates.' + type: string + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + nodeAffinityLabels: + additionalProperties: + type: string + description: Labels to use for node affinity, which will be used in instance + scheduling. + type: object + nodeType: + description: The node type to use for nodes group that are created from + this template. + type: string + nodeTypeFlexibility: + $ref: '#/components/schemas/NodeTemplateNodeTypeFlexibility' + description: The flexible properties of the desired node type. Node groups + that use this node template will create nodes of a type that matches these + properties. This field is mutually exclusive with the node_type property; + you can only define one or the other, but not both. + region: + description: '[Output Only] The name of the region where the node template + resides, such as us-central1.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + serverBinding: + $ref: '#/components/schemas/ServerBinding' + description: 'Sets the binding properties for the physical server. Valid + values include: - *[Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs + on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts + VMs on the same physical server whenever possible See Sole-tenant node + options for more information.' + status: + description: '[Output Only] The status of the node template. One of the + following values: CREATING, READY, and DELETING.' + enum: + - CREATING + - DELETING + - INVALID + - READY + type: string + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the + status.' + type: string + type: object + NodeTemplateAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/NodeTemplatesScopedList' + description: '[Output Only] Name of the scope containing this set of node + templates.' + description: A list of NodeTemplatesScopedList resources. + type: object + kind: + default: compute#nodeTemplateAggregatedList + description: '[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList + for aggregated lists of node templates.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeTemplateList: + description: Contains a list of node templates. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NodeTemplate resources. + items: + $ref: '#/components/schemas/NodeTemplate' + type: array + kind: + default: compute#nodeTemplateList + description: '[Output Only] Type of resource.Always compute#nodeTemplateList + for lists of node templates.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeTemplateNodeTypeFlexibility: + properties: + cpus: + type: string + localSsd: + type: string + memory: + type: string + type: object + NodeTemplatesScopedList: + properties: + nodeTemplates: + description: '[Output Only] A list of node templates contained in this scope.' + items: + $ref: '#/components/schemas/NodeTemplate' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + node templates 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeType: + description: Represent a sole-tenant Node Type resource. Each node within a + node group must have a node type. A node type specifies the total amount of + cores and memory for that node. Currently, the only available node type is + n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available + in multiple zones. For more information read Node types. + properties: + cpuPlatform: + description: '[Output Only] The CPU platform used by this node type.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + node type.' + description: + description: '[Output Only] An optional textual description of the resource.' + type: string + guestCpus: + description: '[Output Only] The number of virtual CPUs that are available + to the node type.' + format: int32 + type: integer + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#nodeType + description: '[Output Only] The type of the resource. Always compute#nodeType + for node types.' + type: string + localSsdGb: + description: '[Output Only] Local SSD available to the node type, defined + in GB.' + format: int32 + type: integer + memoryMb: + description: '[Output Only] The amount of physical memory available to the + node type, defined in MB.' + format: int32 + type: integer + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + zone: + description: '[Output Only] The name of the zone where the node type resides, + such as us-central1-a.' + type: string + type: object + NodeTypeAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/NodeTypesScopedList' + description: '[Output Only] Name of the scope containing this set of node + types.' + description: A list of NodeTypesScopedList resources. + type: object + kind: + default: compute#nodeTypeAggregatedList + description: '[Output Only] Type of resource.Always compute#nodeTypeAggregatedList + for aggregated lists of node types.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeTypeList: + description: Contains a list of node types. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NodeType resources. + items: + $ref: '#/components/schemas/NodeType' + type: array + kind: + default: compute#nodeTypeList + description: '[Output Only] Type of resource.Always compute#nodeTypeList + for lists of node types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeTypesScopedList: + properties: + nodeTypes: + description: '[Output Only] A list of node types contained in this scope.' + items: + $ref: '#/components/schemas/NodeType' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + node types 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NotificationEndpoint: + description: Represents a notification endpoint. A notification endpoint resource + defines an endpoint to receive notifications when there are status changes + detected by the associated health check service. For more information, see + Health checks overview. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + grpcSettings: + $ref: '#/components/schemas/NotificationEndpointGrpcSettings' + description: Settings of the gRPC notification endpoint including the endpoint + URL and the retry duration. + id: + description: '[Output Only] A unique identifier for this resource type. + The server generates this identifier.' + format: uint64 + type: string + kind: + default: compute#notificationEndpoint + description: '[Output Only] Type of the resource. Always compute#notificationEndpoint + for notification endpoints.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + region: + description: '[Output Only] URL of the region where the notification endpoint + resides. This field applies only to the regional resource. You must specify + this field as part of the HTTP request URL. It is not settable as a field + in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + NotificationEndpointGrpcSettings: + description: Represents a gRPC setting that describes one gRPC notification + endpoint and the retry duration attempting to send notification to this endpoint. + properties: + authority: + description: Optional. If specified, this field is used to set the authority + header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 + type: string + endpoint: + description: Endpoint to which gRPC notifications are sent. This must be + a valid gRPCLB DNS name. + type: string + payloadName: + description: Optional. If specified, this field is used to populate the + "name" field in gRPC requests. + type: string + resendInterval: + $ref: '#/components/schemas/Duration' + description: Optional. This field is used to configure how often to send + a full update of all non-healthy backends. If unspecified, full updates + are not sent. If specified, must be in the range between 600 seconds to + 3600 seconds. Nanos are disallowed. + retryDurationSec: + description: How much time (in seconds) is spent attempting notification + retries until a successful response is received. Default is 30s. Limit + is 20m (1200s). Must be a positive number. + format: uint32 + type: integer + type: object + NotificationEndpointList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NotificationEndpoint resources. + items: + $ref: '#/components/schemas/NotificationEndpoint' + type: array + kind: + default: compute#notificationEndpointList + description: '[Output Only] Type of the resource. Always compute#notificationEndpoint + for notification endpoints.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Operation: + description: 'Represents an Operation resource. Google Compute Engine has three + Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) + * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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.' + properties: + clientOperationId: + description: '[Output Only] The value of `requestId` if you provided it + in the request. Not present otherwise.' + type: string + creationTimestamp: + description: '[Deprecated] This field is deprecated.' + type: string + description: + description: '[Output Only] A textual description of the operation, which + is set when the operation is created.' + type: string + endTime: + description: '[Output Only] The time that this operation was completed. + This value is in RFC3339 text format.' + type: string + error: + description: '[Output Only] If errors are generated during processing of + the operation, this field will be populated.' + 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 + 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 + httpErrorMessage: + description: '[Output Only] If the operation fails, this field contains + the HTTP error message that was returned, such as `NOT FOUND`.' + type: string + httpErrorStatusCode: + description: '[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.' + format: int32 + type: integer + id: + description: '[Output Only] The unique identifier for the operation. This + identifier is defined by the server.' + format: uint64 + type: string + insertTime: + description: '[Output Only] The time that this operation was requested. + This value is in RFC3339 text format.' + type: string + kind: + default: compute#operation + description: '[Output Only] Type of the resource. Always `compute#operation` + for Operation resources.' + type: string + name: + description: '[Output Only] Name of the operation.' + type: string + operationGroupId: + description: '[Output Only] An ID that represents a group of operations, + such as when a group of operations results from a `bulkInsert` API request.' + type: string + operationType: + description: '[Output Only] The type of operation, such as `insert`, `update`, + or `delete`, and so on.' + type: string + progress: + description: '[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.' + format: int32 + type: integer + region: + description: '[Output Only] The URL of the region where the operation resides. + Only applicable when performing regional operations.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + startTime: + description: '[Output Only] The time that this operation was started by + the server. This value is in RFC3339 text format.' + type: string + status: + description: '[Output Only] The status of the operation, which can be one + of the following: `PENDING`, `RUNNING`, or `DONE`.' + enum: + - DONE + - PENDING + - RUNNING + type: string + statusMessage: + description: '[Output Only] An optional textual description of the current + status of the operation.' + type: string + targetId: + description: '[Output Only] The unique target ID, which identifies a specific + incarnation of the target resource.' + format: uint64 + type: string + targetLink: + description: '[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.' + type: string + user: + description: '[Output Only] User who requested the operation, for example: + `user@example.com`.' + type: string + warnings: + description: '[Output Only] If warning messages are generated during processing + of the operation, this field will be populated.' + items: + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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: array + zone: + description: '[Output Only] The URL of the zone where the operation resides. + Only applicable when performing per-zone operations.' + type: string + type: object + OperationAggregatedList: + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/OperationsScopedList' + description: '[Output Only] Name of the scope containing this set of operations.' + description: '[Output Only] A map of scoped operation lists.' + type: object + kind: + default: compute#operationAggregatedList + description: '[Output Only] Type of resource. Always `compute#operationAggregatedList` + for aggregated lists of operations.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + OperationList: + description: Contains a list of Operation resources. + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + description: '[Output Only] A list of Operation resources.' + items: + $ref: '#/components/schemas/Operation' + type: array + kind: + default: compute#operationList + description: '[Output Only] Type of resource. Always `compute#operations` + for Operations 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + OperationsScopedList: + properties: + operations: + description: '[Output Only] A list of operations contained in this scope.' + items: + $ref: '#/components/schemas/Operation' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of operations 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + OutlierDetection: + description: Settings controlling the eviction of unhealthy hosts from the load + balancing pool for the backend service. + properties: + baseEjectionTime: + $ref: '#/components/schemas/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. + 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. + 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. + 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. + 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. + 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. + format: int32 + type: integer + interval: + $ref: '#/components/schemas/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. + maxEjectionPercent: + description: Maximum percentage of hosts in the load balancing pool for + the backend service that can be ejected. 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. + 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. + 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.' + format: int32 + type: integer + type: object + PacketIntervals: + description: 'Next free: 7' + properties: + avgMs: + description: Average observed inter-packet interval in milliseconds. + format: int64 + type: string + duration: + description: From how long ago in the past these intervals were observed. + enum: + - DURATION_UNSPECIFIED + - HOUR + - MAX + - MINUTE + type: string + maxMs: + description: Maximum observed inter-packet interval in milliseconds. + format: int64 + type: string + minMs: + description: Minimum observed inter-packet interval in milliseconds. + format: int64 + type: string + numIntervals: + description: Number of inter-packet intervals from which these statistics + were derived. + format: int64 + type: string + type: + description: The type of packets for which inter-packet intervals were computed. + enum: + - LOOPBACK + - RECEIVE + - TRANSMIT + - TYPE_UNSPECIFIED + type: string + type: object + PacketMirroring: + description: Represents a Packet Mirroring resource. Packet Mirroring clones + the traffic of specified instances in your Virtual Private Cloud (VPC) network + and forwards it to a collector destination, such as an instance group of an + internal TCP/UDP load balancer, for analysis or examination. For more information + about setting up Packet Mirroring, see Using Packet Mirroring. + properties: + collectorIlb: + $ref: '#/components/schemas/PacketMirroringForwardingRuleInfo' + description: The Forwarding Rule resource of type loadBalancingScheme=INTERNAL + that will be used as collector for mirrored traffic. The specified forwarding + rule must have isMirroringCollector set to true. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + enable: + description: Indicates whether or not this packet mirroring takes effect. + If set to FALSE, this packet mirroring policy will not be enforced on + the network. The default is TRUE. + enum: + - 'FALSE' + - 'TRUE' + type: string + filter: + $ref: '#/components/schemas/PacketMirroringFilter' + description: Filter for mirrored traffic. If unspecified, all traffic is + mirrored. + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#packetMirroring + description: '[Output Only] Type of the resource. Always compute#packetMirroring + for packet mirrorings.' + type: string + mirroredResources: + $ref: '#/components/schemas/PacketMirroringMirroredResourceInfo' + description: PacketMirroring mirroredResourceInfos. MirroredResourceInfo + specifies a set of mirrored VM instances, subnetworks and/or tags for + which traffic from/to all VM instances will be mirrored. + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + $ref: '#/components/schemas/PacketMirroringNetworkInfo' + description: Specifies the mirrored VPC network. Only packets in this network + will be mirrored. All mirrored VMs should have a NIC in the given network. + All mirrored subnetworks should belong to the given network. + priority: + description: The priority of applying this configuration. Priority is used + to break ties in cases where there is more than one matching rule. In + the case of two rules that apply for a given Instance, the one with the + lowest-numbered priority value wins. Default value is 1000. Valid range + is 0 through 65535. + format: uint32 + type: integer + region: + description: '[Output Only] URI of the region where the packetMirroring + resides.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + PacketMirroringAggregatedList: + description: Contains a list of packetMirrorings. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/PacketMirroringsScopedList' + description: Name of the scope containing this set of packetMirrorings. + description: A list of PacketMirroring resources. + type: object + kind: + default: compute#packetMirroringAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PacketMirroringFilter: + properties: + IPProtocols: + description: Protocols that apply as filter on mirrored traffic. If no protocols + are specified, all traffic that matches the specified CIDR ranges is mirrored. + If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored. + items: + type: string + type: array + cidrRanges: + description: IP CIDR ranges that apply as filter on the source (ingress) + or destination (egress) IP in the IP header. Only IPv4 is supported. If + no ranges are specified, all traffic that matches the specified IPProtocols + is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic + is mirrored. + items: + type: string + type: array + direction: + description: Direction of traffic to mirror, either INGRESS, EGRESS, or + BOTH. The default is BOTH. + enum: + - BOTH + - EGRESS + - INGRESS + type: string + type: object + PacketMirroringForwardingRuleInfo: + properties: + canonicalUrl: + description: '[Output Only] Unique identifier for the forwarding rule; defined + by the server.' + type: string + url: + description: Resource URL to the forwarding rule representing the ILB configured + as destination of the mirrored traffic. + type: string + type: object + PacketMirroringList: + description: Contains a list of PacketMirroring resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of PacketMirroring resources. + items: + $ref: '#/components/schemas/PacketMirroring' + type: array + kind: + default: compute#packetMirroringList + description: '[Output Only] Type of resource. Always compute#packetMirroring + for packetMirrorings.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PacketMirroringMirroredResourceInfo: + properties: + instances: + description: A set of virtual machine instances that are being mirrored. + They must live in zones contained in the same region as this packetMirroring. + Note that this config will apply only to those network interfaces of the + Instances that belong to the network specified in this packetMirroring. + You may specify a maximum of 50 Instances. + items: + $ref: '#/components/schemas/PacketMirroringMirroredResourceInfoInstanceInfo' + type: array + subnetworks: + description: A set of subnetworks for which traffic from/to all VM instances + will be mirrored. They must live in the same region as this packetMirroring. + You may specify a maximum of 5 subnetworks. + items: + $ref: '#/components/schemas/PacketMirroringMirroredResourceInfoSubnetInfo' + type: array + tags: + description: A set of mirrored tags. Traffic from/to all VM instances that + have one or more of these tags will be mirrored. + items: + type: string + type: array + type: object + PacketMirroringMirroredResourceInfoInstanceInfo: + properties: + canonicalUrl: + description: '[Output Only] Unique identifier for the instance; defined + by the server.' + type: string + url: + description: Resource URL to the virtual machine instance which is being + mirrored. + type: string + type: object + PacketMirroringMirroredResourceInfoSubnetInfo: + properties: + canonicalUrl: + description: '[Output Only] Unique identifier for the subnetwork; defined + by the server.' + type: string + url: + description: Resource URL to the subnetwork for which traffic from/to all + VM instances will be mirrored. + type: string + type: object + PacketMirroringNetworkInfo: + properties: + canonicalUrl: + description: '[Output Only] Unique identifier for the network; defined by + the server.' + type: string + url: + description: URL of the network resource. + type: string + type: object + PacketMirroringsScopedList: + properties: + packetMirrorings: + description: A list of packetMirrorings contained in this scope. + items: + $ref: '#/components/schemas/PacketMirroring' + type: array + warning: + description: Informational warning which replaces the list of packetMirrorings + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PathMatcher: + description: A matcher for the path portion of the URL. The BackendService from + the longest-matched rule will serve the URL. If no rule was matched, the default + service will be used. + properties: + defaultRouteAction: + $ref: '#/components/schemas/HttpRouteAction' + description: defaultRouteAction takes effect when none of the pathRules + or routeRules match. The load balancer performs advanced routing actions + like URL rewrites, header transformations, etc. prior to forwarding the + request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, + defaultService must not be set. Conversely if defaultService is set, defaultRouteAction + cannot contain any weightedBackendServices. Only one of defaultRouteAction + or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers + support only the urlRewrite action within a pathMatcher's defaultRouteAction. + defaultService: + description: 'The full or partial URL to the BackendService resource. This + will be used if none of the pathRules or routeRules defined by this PathMatcher + are matched. For example, the following are all valid URLs to a BackendService + resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService + - compute/v1/projects/project/global/backendServices/backendService - + global/backendServices/backendService If defaultRouteAction is additionally + specified, advanced routing actions like URL Rewrites, etc. take effect + prior to sending the request to the backend. However, if defaultService + is specified, defaultRouteAction cannot contain any weightedBackendServices. + Conversely, if defaultRouteAction specifies any weightedBackendServices, + defaultService must not be specified. Only one of defaultService, defaultUrlRedirect + or defaultRouteAction.weightedBackendService must be set. Authorization + requires one or more of the following Google IAM permissions on the specified + resource default_service: - compute.backendBuckets.use - compute.backendServices.use ' + type: string + defaultUrlRedirect: + $ref: '#/components/schemas/HttpRedirectAction' + description: When none of the specified pathRules or routeRules match, the + request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect + is specified, defaultService or defaultRouteAction must not be set. Not + supported when the URL map is bound to target gRPC proxy. + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + headerAction: + $ref: '#/components/schemas/HttpHeaderAction' + description: Specifies changes to request and response headers that need + to take effect for the selected backendService. HeaderAction specified + here are applied after the matching HttpRouteRule HeaderAction and before + the HeaderAction in the UrlMap Note that headerAction is not supported + for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. + Not supported when the URL map is bound to target gRPC proxy that has + validateForProxyless field set to true. + name: + description: The name to which this PathMatcher is referred by the HostRule. + type: string + pathRules: + description: 'The list of path rules. Use this list instead of routeRules + when routing based on simple path matching is all that''s required. The + order by which path rules are specified does not matter. Matches are always + done on the longest-path-first basis. For example: a pathRule with a path + /a/b/c/* will match before /a/b/* irrespective of the order in which those + paths appear in this list. Within a given pathMatcher, only one of pathRules + or routeRules must be set.' + items: + $ref: '#/components/schemas/PathRule' + type: array + routeRules: + description: The list of HTTP route rules. Use this list instead of pathRules + when advanced route matching and routing actions are desired. routeRules + are evaluated in order of priority, from the lowest to highest number. + Within a given pathMatcher, you can set only one of pathRules or routeRules. + items: + $ref: '#/components/schemas/HttpRouteRule' + type: array + type: object + PathRule: + description: A path-matching rule for a URL. If matched, will use the specified + BackendService to handle the traffic arriving at this URL. + properties: + paths: + description: 'The list of path patterns to match. Each must start with / + and the only place a * is allowed is at the end following a /. The string + fed to the path matcher does not include any text after the first ? or + #, and those chars are not allowed here.' + items: + type: string + type: array + routeAction: + $ref: '#/components/schemas/HttpRouteAction' + description: In response to a matching path, the load balancer performs + advanced routing actions like URL rewrites, header transformations, etc. + prior to forwarding the request to the selected backend. If routeAction + specifies any weightedBackendServices, service must not be set. Conversely + if service is set, routeAction cannot contain any weightedBackendServices. + Only one of routeAction or urlRedirect must be set. UrlMaps for external + HTTP(S) load balancers support only the urlRewrite action within a pathRule's + routeAction. + service: + description: The full or partial URL of the backend service resource to + which traffic is directed if this rule is matched. If routeAction is additionally + specified, advanced routing actions like URL Rewrites, etc. take effect + prior to sending the request to the backend. However, if service is specified, + routeAction cannot contain any weightedBackendService s. Conversely, if + routeAction specifies any weightedBackendServices, service must not be + specified. Only one of urlRedirect, service or routeAction.weightedBackendService + must be set. + type: string + urlRedirect: + $ref: '#/components/schemas/HttpRedirectAction' + description: When a path pattern is matched, the request is redirected to + a URL specified by urlRedirect. If urlRedirect is specified, service or + routeAction must not be set. Not supported when the URL map is bound to + target gRPC proxy. + type: object + PerInstanceConfig: + properties: + fingerprint: + description: Fingerprint of this per-instance config. This field can be + used in optimistic locking. It is ignored when inserting a per-instance + config. An up-to-date fingerprint must be provided in order to update + an existing per-instance config or the field needs to be unset. + format: byte + type: string + name: + description: The name of a per-instance config and its corresponding instance. + Serves as a merge key during UpdatePerInstanceConfigs operations, that + is, if a per-instance config with the same name exists then it will be + updated, otherwise a new one will be created for the VM instance with + the same name. An attempt to create a per-instance config for a VM instance + that either doesn't exist or is not part of the group will result in an + error. + type: string + preservedState: + $ref: '#/components/schemas/PreservedState' + description: The intended preserved state for the given instance. Does not + contain preserved state generated from a stateful policy. + status: + description: The status of applying this per-instance config on the corresponding + managed instance. + enum: + - APPLYING + - DELETING + - EFFECTIVE + - NONE + - UNAPPLIED + - UNAPPLIED_DELETION + 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` to a single `role`. Members + can be user accounts, service accounts, Google groups, and domains (such as + G Suite). A `role` is a named list of permissions; each `role` can be an IAM + predefined role or a user-created custom role. For some types of Google Cloud + resources, a `binding` can also specify a `condition`, which is a logical + expression that allows access to a resource only if the expression evaluates + to `true`. A condition can add constraints based on attributes of the request, + the resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": + "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" + ], "condition": { "title": "expirable access", "description": "Does not grant + access after Sep 2020", "expression": "request.time < timestamp(''2020-10-01T00:00:00.000Z'')", + } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: + - members: - user:mike@example.com - group:admins@example.com - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin + - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access after + Sep 2020 expression: request.time < timestamp(''2020-10-01T00:00:00.000Z'') + etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see + the [IAM documentation](https://cloud.google.com/iam/docs/).' + properties: + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + items: + $ref: '#/components/schemas/AuditConfig' + type: array + bindings: + description: Associates a list of `members` to a `role`. Optionally, may + specify a `condition` that determines how and when the `bindings` are + applied. Each of the `bindings` must contain at least one member. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: '`etag` is used for optimistic concurrency control as a way + to help prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` in + the read-modify-write cycle to perform policy updates in order to avoid + race conditions: An `etag` is returned in the response to `getIamPolicy`, + and systems are expected to put that etag in the request to `setIamPolicy` + to ensure that their change will be applied to the same version of the + policy. **Important:** If you use IAM Conditions, you must include the + `etag` field whenever you call `setIamPolicy`. If you omit this field, + then IAM allows you to overwrite a version `3` policy with a version `1` + policy, and all of the conditions in the version `3` policy are lost.' + format: byte + type: string + iamOwned: + description: This is deprecated and has no effect. Do not use. + type: boolean + rules: + description: This is deprecated and has no effect. Do not use. + items: + $ref: '#/components/schemas/Rule' + type: array + version: + description: 'Specifies the format of the policy. Valid values are `0`, + `1`, and `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify version + `3`. This requirement applies to the following operations: * Getting a + policy that includes a conditional role binding * Adding a conditional + role binding to a policy * Changing a conditional role binding in a policy + * Removing any role binding, with or without a condition, from a policy + that includes conditions **Important:** If you use IAM Conditions, you + must include the `etag` field whenever you call `setIamPolicy`. If you + omit this field, then IAM allows you to overwrite a version `3` policy + with a version `1` policy, and all of the conditions in the version `3` + policy are lost. If a policy does not include any conditions, operations + on that policy may specify any valid version or leave the field unset. + To learn which resources support conditions in their IAM policies, see + the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).' + format: int32 + type: integer + type: object + PreconfiguredWafSet: + properties: + expressionSets: + description: List of entities that are currently supported for WAF rules. + items: + $ref: '#/components/schemas/WafExpressionSet' + type: array + type: object + PreservedState: + description: Preserved state for a given instance. + properties: + disks: + additionalProperties: + $ref: '#/components/schemas/PreservedStatePreservedDisk' + description: Preserved disks defined for this instance. This map is keyed + with the device names of the disks. + type: object + metadata: + additionalProperties: + type: string + description: Preserved metadata defined for this instance. + type: object + type: object + PreservedStatePreservedDisk: + properties: + autoDelete: + description: 'These stateful disks will never be deleted during autohealing, + update, instance recreate operations. This flag is used to configure if + the disk should be deleted after it is no longer used by the group, e.g. + when the given instance or the whole MIG is deleted. Note: disks attached + in READ_ONLY mode cannot be auto-deleted.' + enum: + - NEVER + - ON_PERMANENT_INSTANCE_DELETION + type: string + mode: + description: The mode in which to attach this disk, either READ_WRITE or + READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE + mode. + enum: + - READ_ONLY + - READ_WRITE + type: string + source: + description: The URL of the disk resource that is stateful and should be + attached to the VM instance. + type: string + type: object + Project: + description: Represents a Project resource. A project is used to organize resources + in a Google Cloud Platform environment. For more information, read about the + Resource Hierarchy. + properties: + commonInstanceMetadata: + $ref: '#/components/schemas/Metadata' + description: Metadata key/value pairs available to all instances contained + in this project. See Custom metadata for more information. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + defaultNetworkTier: + description: 'This signifies the default network tier used for configuring + resources of the project and can only take the following values: PREMIUM, + STANDARD. Initially the default network tier is PREMIUM.' + enum: + - PREMIUM + - STANDARD + type: string + defaultServiceAccount: + description: '[Output Only] Default service account used by VMs running + in this project.' + type: string + description: + description: An optional textual description of the resource. + type: string + enabledFeatures: + description: Restricted features enabled for use on this project. + items: + type: string + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server. This is *not* the project ID, and + is just a unique ID used by Compute Engine to identify resources.' + format: uint64 + type: string + kind: + default: compute#project + description: '[Output Only] Type of the resource. Always compute#project + for projects.' + type: string + name: + description: 'The project ID. For example: my-example-project. Use the project + ID to make requests to Compute Engine.' + type: string + quotas: + description: '[Output Only] Quotas assigned to this project.' + items: + $ref: '#/components/schemas/Quota' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + usageExportLocation: + $ref: '#/components/schemas/UsageExportLocation' + description: The naming prefix for daily usage reports and the Google Cloud + Storage bucket where they are stored. + xpnProjectStatus: + description: '[Output Only] The role this project has in a shared VPC configuration. + Currently, only projects with the host role, which is specified by the + value HOST, are differentiated.' + enum: + - HOST + - UNSPECIFIED_XPN_PROJECT_STATUS + type: string + type: object + ProjectsDisableXpnResourceRequest: + properties: + xpnResource: + $ref: '#/components/schemas/XpnResourceId' + description: Service resource (a.k.a service project) ID. + type: object + ProjectsEnableXpnResourceRequest: + properties: + xpnResource: + $ref: '#/components/schemas/XpnResourceId' + description: Service resource (a.k.a service project) ID. + type: object + ProjectsGetXpnResources: + properties: + kind: + default: compute#projectsGetXpnResources + description: '[Output Only] Type of resource. Always compute#projectsGetXpnResources + for lists of service resources (a.k.a service projects)' + 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 + resources: + description: Service resources (a.k.a service projects) attached to this + project as their shared VPC host. + items: + $ref: '#/components/schemas/XpnResourceId' + type: array + type: object + ProjectsListXpnHostsRequest: + properties: + organization: + description: Optional organization ID managed by Cloud Resource Manager, + for which to list shared VPC host projects. If not specified, the organization + will be inferred from the project. + type: string + type: object + ProjectsSetDefaultNetworkTierRequest: + properties: + networkTier: + description: Default network tier to be set. + enum: + - PREMIUM + - STANDARD + type: string + type: object + PublicAdvertisedPrefix: + description: A public advertised prefix represents an aggregated IP prefix or + netblock which customers bring to cloud. The IP prefix is a single unit of + route advertisement and is announced globally to the internet. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + dnsVerificationIp: + description: The IPv4 address to be used for reverse DNS verification. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date + fingerprint must be provided in order to update the PublicAdvertisedPrefix, + otherwise the request will fail with error 412 conditionNotMet. To see + the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource type. + The server generates this identifier.' + format: uint64 + type: string + ipCidrRange: + description: The IPv4 address range, in CIDR format, represented by this + public advertised prefix. + type: string + kind: + default: compute#publicAdvertisedPrefix + description: '[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix + for public advertised prefixes.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + publicDelegatedPrefixs: + description: '[Output Only] The list of public delegated prefixes that exist + for this public advertised prefix.' + items: + $ref: '#/components/schemas/PublicAdvertisedPrefixPublicDelegatedPrefix' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sharedSecret: + description: '[Output Only] The shared secret to be used for reverse DNS + verification.' + type: string + status: + description: The status of the public advertised prefix. + enum: + - INITIAL + - PREFIX_CONFIGURATION_COMPLETE + - PREFIX_CONFIGURATION_IN_PROGRESS + - PREFIX_REMOVAL_IN_PROGRESS + - PTR_CONFIGURED + - REVERSE_DNS_LOOKUP_FAILED + - VALIDATED + type: string + type: object + PublicAdvertisedPrefixList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of PublicAdvertisedPrefix resources. + items: + $ref: '#/components/schemas/PublicAdvertisedPrefix' + type: array + kind: + default: compute#publicAdvertisedPrefixList + description: '[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix + for public advertised prefixes.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PublicAdvertisedPrefixPublicDelegatedPrefix: + description: Represents a CIDR range which can be used to assign addresses. + properties: + ipRange: + description: The IP address range of the public delegated prefix + type: string + name: + description: The name of the public delegated prefix + type: string + project: + description: The project number of the public delegated prefix + type: string + region: + description: The region of the public delegated prefix if it is regional. + If absent, the prefix is global. + type: string + status: + description: 'The status of the public delegated prefix. Possible values + are: INITIALIZING: The public delegated prefix is being initialized and + addresses cannot be created yet. ANNOUNCED: The public delegated prefix + is active.' + type: string + type: object + PublicDelegatedPrefix: + description: A PublicDelegatedPrefix resource represents an IP block within + a PublicAdvertisedPrefix that is configured within a single cloud scope (global + or region). IPs in the block can be allocated to resources within that scope. + Public delegated prefixes may be further broken up into smaller IP blocks + in the same scope as the parent block. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint + must be provided in order to update the PublicDelegatedPrefix, otherwise + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource type. + The server generates this identifier.' + format: uint64 + type: string + ipCidrRange: + description: The IPv4 address range, in CIDR format, represented by this + public delegated prefix. + type: string + isLiveMigration: + description: If true, the prefix will be live migrated. + type: boolean + kind: + default: compute#publicDelegatedPrefix + description: '[Output Only] Type of the resource. Always compute#publicDelegatedPrefix + for public delegated prefixes.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + parentPrefix: + description: The URL of parent prefix. Either PublicAdvertisedPrefix or + PublicDelegatedPrefix. + type: string + publicDelegatedSubPrefixs: + description: The list of sub public delegated prefixes that exist for this + public delegated prefix. + items: + $ref: '#/components/schemas/PublicDelegatedPrefixPublicDelegatedSubPrefix' + type: array + region: + description: '[Output Only] URL of the region where the public delegated + prefix resides. This field applies only to the region resource. You must + specify this field as part of the HTTP request URL. It is not settable + as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of the public delegated prefix.' + enum: + - ANNOUNCED + - DELETING + - INITIALIZING + - READY_TO_ANNOUNCE + type: string + type: object + PublicDelegatedPrefixAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/PublicDelegatedPrefixesScopedList' + description: '[Output Only] Name of the scope containing this set of PublicDelegatedPrefixes.' + description: A list of PublicDelegatedPrefixesScopedList resources. + type: object + kind: + default: compute#publicDelegatedPrefixAggregatedList + description: '[Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList + for aggregated lists of public delegated prefixes.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PublicDelegatedPrefixList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of PublicDelegatedPrefix resources. + items: + $ref: '#/components/schemas/PublicDelegatedPrefix' + type: array + kind: + default: compute#publicDelegatedPrefixList + description: '[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList + for public delegated prefixes.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PublicDelegatedPrefixPublicDelegatedSubPrefix: + description: Represents a sub PublicDelegatedPrefix. + properties: + delegateeProject: + description: Name of the project scoping this PublicDelegatedSubPrefix. + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + ipCidrRange: + description: The IPv4 address range, in CIDR format, represented by this + sub public delegated prefix. + type: string + isAddress: + description: Whether the sub prefix is delegated to create Address resources + in the delegatee project. + type: boolean + name: + description: The name of the sub public delegated prefix. + type: string + region: + description: '[Output Only] The region of the sub public delegated prefix + if it is regional. If absent, the sub prefix is global.' + type: string + status: + description: '[Output Only] The status of the sub public delegated prefix.' + enum: + - ACTIVE + - INACTIVE + type: string + type: object + PublicDelegatedPrefixesScopedList: + properties: + publicDelegatedPrefixes: + description: '[Output Only] A list of PublicDelegatedPrefixes contained + in this scope.' + items: + $ref: '#/components/schemas/PublicDelegatedPrefix' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of public delegated prefixes 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Quota: + description: A quotas entry. + properties: + limit: + description: '[Output Only] Quota limit for this metric.' + format: double + type: number + metric: + description: '[Output Only] Name of the quota metric.' + enum: + - A2_CPUS + - AFFINITY_GROUPS + - AUTOSCALERS + - BACKEND_BUCKETS + - BACKEND_SERVICES + - C2D_CPUS + - C2_CPUS + - C3_CPUS + - COMMITMENTS + - COMMITTED_A2_CPUS + - COMMITTED_C2D_CPUS + - COMMITTED_C2_CPUS + - COMMITTED_C3_CPUS + - COMMITTED_CPUS + - COMMITTED_E2_CPUS + - COMMITTED_LICENSES + - COMMITTED_LOCAL_SSD_TOTAL_GB + - COMMITTED_MEMORY_OPTIMIZED_CPUS + - COMMITTED_N2A_CPUS + - COMMITTED_N2D_CPUS + - COMMITTED_N2_CPUS + - COMMITTED_NVIDIA_A100_GPUS + - COMMITTED_NVIDIA_K80_GPUS + - COMMITTED_NVIDIA_P100_GPUS + - COMMITTED_NVIDIA_P4_GPUS + - COMMITTED_NVIDIA_T4_GPUS + - COMMITTED_NVIDIA_V100_GPUS + - COMMITTED_T2D_CPUS + - CPUS + - CPUS_ALL_REGIONS + - DISKS_TOTAL_GB + - E2_CPUS + - EXTERNAL_NETWORK_LB_FORWARDING_RULES + - EXTERNAL_PROTOCOL_FORWARDING_RULES + - EXTERNAL_VPN_GATEWAYS + - FIREWALLS + - FORWARDING_RULES + - GLOBAL_INTERNAL_ADDRESSES + - GPUS_ALL_REGIONS + - HEALTH_CHECKS + - IMAGES + - INSTANCES + - INSTANCE_GROUPS + - INSTANCE_GROUP_MANAGERS + - INSTANCE_TEMPLATES + - INTERCONNECTS + - INTERCONNECT_ATTACHMENTS_PER_REGION + - INTERCONNECT_ATTACHMENTS_TOTAL_MBPS + - INTERCONNECT_TOTAL_GBPS + - INTERNAL_ADDRESSES + - INTERNAL_TRAFFIC_DIRECTOR_FORWARDING_RULES + - IN_PLACE_SNAPSHOTS + - IN_USE_ADDRESSES + - IN_USE_BACKUP_SCHEDULES + - IN_USE_SNAPSHOT_SCHEDULES + - LOCAL_SSD_TOTAL_GB + - M1_CPUS + - M2_CPUS + - MACHINE_IMAGES + - N2A_CPUS + - N2D_CPUS + - N2_CPUS + - NETWORKS + - NETWORK_ENDPOINT_GROUPS + - NETWORK_FIREWALL_POLICIES + - NODE_GROUPS + - NODE_TEMPLATES + - NVIDIA_A100_GPUS + - NVIDIA_K80_GPUS + - NVIDIA_P100_GPUS + - NVIDIA_P100_VWS_GPUS + - NVIDIA_P4_GPUS + - NVIDIA_P4_VWS_GPUS + - NVIDIA_T4_GPUS + - NVIDIA_T4_VWS_GPUS + - NVIDIA_V100_GPUS + - PACKET_MIRRORINGS + - PD_EXTREME_TOTAL_PROVISIONED_IOPS + - PREEMPTIBLE_CPUS + - PREEMPTIBLE_LOCAL_SSD_GB + - PREEMPTIBLE_NVIDIA_A100_GPUS + - PREEMPTIBLE_NVIDIA_K80_GPUS + - PREEMPTIBLE_NVIDIA_P100_GPUS + - PREEMPTIBLE_NVIDIA_P100_VWS_GPUS + - PREEMPTIBLE_NVIDIA_P4_GPUS + - PREEMPTIBLE_NVIDIA_P4_VWS_GPUS + - PREEMPTIBLE_NVIDIA_T4_GPUS + - PREEMPTIBLE_NVIDIA_T4_VWS_GPUS + - PREEMPTIBLE_NVIDIA_V100_GPUS + - PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK + - PSC_INTERNAL_LB_FORWARDING_RULES + - PUBLIC_ADVERTISED_PREFIXES + - PUBLIC_DELEGATED_PREFIXES + - REGIONAL_AUTOSCALERS + - REGIONAL_INSTANCE_GROUP_MANAGERS + - RESERVATIONS + - RESOURCE_POLICIES + - ROUTERS + - ROUTES + - SECURITY_POLICIES + - SECURITY_POLICIES_PER_REGION + - SECURITY_POLICY_CEVAL_RULES + - SECURITY_POLICY_RULES + - SECURITY_POLICY_RULES_PER_REGION + - SERVICE_ATTACHMENTS + - SNAPSHOTS + - SSD_TOTAL_GB + - SSL_CERTIFICATES + - STATIC_ADDRESSES + - STATIC_BYOIP_ADDRESSES + - SUBNETWORKS + - T2D_CPUS + - TARGET_HTTPS_PROXIES + - TARGET_HTTP_PROXIES + - TARGET_INSTANCES + - TARGET_POOLS + - TARGET_SSL_PROXIES + - TARGET_TCP_PROXIES + - TARGET_VPN_GATEWAYS + - URL_MAPS + - VPN_GATEWAYS + - VPN_TUNNELS + - XPN_SERVICE_PROJECTS + type: string + owner: + description: '[Output Only] Owning resource. This is the resource on which + this quota is applied.' + type: string + usage: + description: '[Output Only] Current usage of this metric.' + format: double + type: number + type: object + Reference: + description: Represents a reference to a resource. + properties: + kind: + default: compute#reference + description: '[Output Only] Type of the resource. Always compute#reference + for references.' + type: string + referenceType: + description: 'A description of the reference type with no implied semantics. + Possible values include: 1. MEMBER_OF ' + type: string + referrer: + description: URL of the resource which refers to the target. + type: string + target: + description: URL of the resource to which this reference points. + type: string + type: object + Region: + description: Represents a Region resource. A region is a geographical area where + a resource is located. For more information, read Regions and Zones. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + region.' + description: + description: '[Output Only] Textual description of the resource.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#region + description: '[Output Only] Type of the resource. Always compute#region + for regions.' + type: string + name: + description: '[Output Only] Name of the resource.' + type: string + quotas: + description: '[Output Only] Quotas assigned to this region.' + items: + $ref: '#/components/schemas/Quota' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] Status of the region, either UP or DOWN.' + enum: + - DOWN + - UP + type: string + supportsPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + zones: + description: '[Output Only] A list of zones available in this region, in + the form of resource URLs.' + items: + type: string + type: array + type: object + RegionAutoscalerList: + description: Contains a list of autoscalers. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Autoscaler resources. + items: + $ref: '#/components/schemas/Autoscaler' + type: array + kind: + default: compute#regionAutoscalerList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionDiskTypeList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of DiskType resources. + items: + $ref: '#/components/schemas/DiskType' + type: array + kind: + default: compute#regionDiskTypeList + description: '[Output Only] Type of resource. Always compute#regionDiskTypeList + for region disk types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionDisksAddResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be added to this disk. + items: + type: string + type: array + type: object + RegionDisksRemoveResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be removed from this disk. + items: + type: string + type: array + type: object + RegionDisksResizeRequest: + properties: + sizeGb: + description: The new size of the regional persistent disk, which is specified + in GB. + format: int64 + type: string + type: object + RegionInstanceGroupList: + description: Contains a list of InstanceGroup resources. + 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: '#/components/schemas/InstanceGroup' + type: array + kind: + default: compute#regionInstanceGroupList + description: The resource type. + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionInstanceGroupManagerDeleteInstanceConfigReq: + description: RegionInstanceGroupManagers.deletePerInstanceConfigs + properties: + names: + description: The list of instance names for which we want to delete per-instance + configs on this managed instance group. + items: + type: string + type: array + type: object + RegionInstanceGroupManagerList: + description: Contains a list of managed instance groups. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceGroupManager resources. + items: + $ref: '#/components/schemas/InstanceGroupManager' + type: array + kind: + default: compute#regionInstanceGroupManagerList + description: '[Output Only] The resource type, which is always compute#instanceGroupManagerList + for a list of managed instance groups that exist in th regional scope.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionInstanceGroupManagerPatchInstanceConfigReq: + description: RegionInstanceGroupManagers.patchPerInstanceConfigs + properties: + perInstanceConfigs: + description: The list of per-instance configs to insert or patch on this + managed instance group. + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + RegionInstanceGroupManagerUpdateInstanceConfigReq: + description: RegionInstanceGroupManagers.updatePerInstanceConfigs + properties: + perInstanceConfigs: + description: The list of per-instance configs to insert or patch on this + managed instance group. + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + RegionInstanceGroupManagersAbandonInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to abandon. This can be a + full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + type: object + RegionInstanceGroupManagersApplyUpdatesRequest: + description: RegionInstanceGroupManagers.applyUpdatesToInstances + properties: + allInstances: + description: "Flag to update all instances instead of specified list of\ + \ \u201Cinstances\u201D. If the flag is set to true then the instances\ + \ may not be specified in the request." + type: boolean + instances: + description: The list of URLs of one or more instances for which you want + to apply updates. Each URL can be a full URL or a partial URL, such as + zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + minimalAction: + description: 'The minimal action that you want to perform on each instance + during the update: - REPLACE: At minimum, delete the instance and create + it again. - RESTART: Stop the instance and start it again. - REFRESH: + Do not stop the instance. - NONE: Do not disrupt the instance at all. + By default, the minimum action is NONE. If your update requires a more + disruptive action than you set with this flag, the necessary action is + performed to execute the update.' + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + mostDisruptiveAllowedAction: + description: 'The most disruptive action that you want to perform on each + instance during the update: - REPLACE: Delete the instance and create + it again. - RESTART: Stop the instance and start it again. - REFRESH: + Do not stop the instance. - NONE: Do not disrupt the instance at all. + By default, the most disruptive allowed action is REPLACE. If your update + requires a more disruptive action than you set with this flag, the update + request will fail.' + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + type: object + RegionInstanceGroupManagersCreateInstancesRequest: + description: RegionInstanceGroupManagers.createInstances + properties: + instances: + description: '[Required] List of specifications of per-instance configs.' + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + RegionInstanceGroupManagersDeleteInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to delete. This can be a + full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + skipInstancesOnValidationError: + description: Specifies whether the request should proceed despite the inclusion + of instances that are not members of the group or that are already in + the process of being deleted or abandoned. If this field is set to `false` + and such an instance is specified in the request, the operation fails. + The operation always fails if the request contains a malformed instance + URL or a reference to an instance that exists in a zone or region other + than the group's zone or region. + type: boolean + type: object + RegionInstanceGroupManagersListErrorsResponse: + properties: + items: + description: '[Output Only] The list of errors of the managed instance group.' + items: + $ref: '#/components/schemas/InstanceManagedByIgmError' + type: array + 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 + type: object + RegionInstanceGroupManagersListInstanceConfigsResp: + properties: + items: + description: '[Output Only] The list of PerInstanceConfig.' + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionInstanceGroupManagersListInstancesResponse: + properties: + managedInstances: + description: A list of managed instances. + items: + $ref: '#/components/schemas/ManagedInstance' + type: array + 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 + type: object + RegionInstanceGroupManagersRecreateRequest: + properties: + instances: + description: The URLs of one or more instances to recreate. This can be + a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + type: object + RegionInstanceGroupManagersSetTargetPoolsRequest: + properties: + fingerprint: + description: Fingerprint of the target pools information, which is a hash + of the contents. This field is used for optimistic locking when you update + the target pool entries. This field is optional. + format: byte + type: string + targetPools: + description: The URL of all TargetPool resources to which instances in the + instanceGroup field are added. The target pools automatically apply to + all of the instances in the managed instance group. + items: + type: string + type: array + type: object + RegionInstanceGroupManagersSetTemplateRequest: + properties: + instanceTemplate: + description: URL of the InstanceTemplate resource from which all new instances + will be created. + type: string + type: object + RegionInstanceGroupsListInstances: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceWithNamedPorts resources. + items: + $ref: '#/components/schemas/InstanceWithNamedPorts' + type: array + kind: + default: compute#regionInstanceGroupsListInstances + description: The resource type. + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionInstanceGroupsListInstancesRequest: + properties: + instanceState: + description: 'Instances in which state should be returned. Valid options + are: ''ALL'', ''RUNNING''. By default, it lists all instances.' + enum: + - ALL + - RUNNING + type: string + portName: + description: Name of port user is interested in. It is optional. If it is + set, only information about this ports will be returned. If it is not + set, all the named ports will be returned. Always lists all instances. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + type: object + RegionInstanceGroupsSetNamedPortsRequest: + properties: + fingerprint: + description: The fingerprint of the named ports information for this instance + group. Use this optional property to prevent conflicts when multiple users + change the named ports settings concurrently. Obtain the fingerprint with + the instanceGroups.get method. Then, include the fingerprint in your request + to ensure that you do not overwrite changes that were applied from another + concurrent request. + format: byte + type: string + namedPorts: + description: The list of named ports to set for this instance group. + items: + $ref: '#/components/schemas/NamedPort' + type: array + type: object + RegionList: + description: Contains a list of region resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Region resources. + items: + $ref: '#/components/schemas/Region' + type: array + kind: + default: compute#regionList + description: '[Output Only] Type of resource. Always compute#regionList + for lists of regions.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionSetLabelsRequest: + properties: + labelFingerprint: + description: The fingerprint of the previous set of labels for this resource, + used to detect conflicts. The fingerprint is initially generated by Compute + Engine and changes after every request to modify or update labels. You + must always provide an up-to-date fingerprint hash in order to update + or change labels. Make a get() request to the resource to get the latest + fingerprint. + format: byte + type: string + labels: + additionalProperties: + type: string + description: The labels to set for this resource. + type: object + type: object + RegionSetPolicyRequest: + properties: + bindings: + description: Flatten Policy to create a backwacd compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + format: byte + type: string + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the ''resource''. + The size of the policy is limited to a few 10s of KB. An empty policy + is in general a valid policy but certain services (like Projects) might + reject them.' + type: object + RegionTargetHttpsProxiesSetSslCertificatesRequest: + properties: + sslCertificates: + description: New set of SslCertificate resources to associate with this + TargetHttpsProxy resource. Currently exactly one SslCertificate resource + must be specified. + items: + type: string + type: array + type: object + RegionUrlMapsValidateRequest: + properties: + resource: + $ref: '#/components/schemas/UrlMap' + description: Content of the UrlMap to be validated. + type: object + RequestMirrorPolicy: + description: A policy that specifies how requests intended for the route's backends + are shadowed to a separate mirrored backend service. Loadbalancer does not + wait for responses from the shadow service. Prior to sending traffic to the + shadow service, the host / authority header is suffixed with -shadow. + properties: + backendService: + description: The full or partial URL to the BackendService resource being + mirrored to. + type: string + type: object + Reservation: + description: Represents a reservation resource. A reservation ensures that capacity + is held in a specific zone even if the reserved VMs are not running. For more + information, read Reserving zonal resources. + properties: + commitment: + description: '[Output Only] Full or partial URL to a parent commitment. + This field displays for reservations that are tied to a commitment.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#reservation + description: '[Output Only] Type of the resource. Always compute#reservations + for reservations.' + type: string + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this + resource.' + type: string + shareSettings: + $ref: '#/components/schemas/ShareSettings' + description: Share-settings for shared-reservation + specificReservation: + $ref: '#/components/schemas/AllocationSpecificSKUReservation' + description: Reservation for instances with specific machine shapes. + specificReservationRequired: + description: Indicates whether the reservation can be consumed by VMs with + affinity for "any" reservation. If the field is set, then only VMs that + target the reservation by name can consume from this reservation. + type: boolean + status: + description: '[Output Only] The status of the reservation.' + enum: + - CREATING + - DELETING + - INVALID + - READY + - UPDATING + type: string + zone: + description: Zone in which the reservation resides. A zone must be provided + if the reservation is created within a commitment. + type: string + type: object + ReservationAffinity: + description: Specifies the reservations that this instance can consume from. + properties: + consumeReservationType: + description: 'Specifies the type of reservation from which this instance + can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, + or NO_RESERVATION. See Consuming reserved instances for examples.' + enum: + - ANY_RESERVATION + - NO_RESERVATION + - SPECIFIC_RESERVATION + - UNSPECIFIED + type: string + key: + description: Corresponds to the label key of a reservation resource. To + target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name + as the key and specify the name of your reservation as its value. + type: string + values: + description: Corresponds to the label values of a reservation resource. + This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" + to target a shared reservation in the same zone but in a different project. + items: + type: string + type: array + type: object + ReservationAggregatedList: + description: Contains a list of reservations. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/ReservationsScopedList' + description: Name of the scope containing this set of reservations. + description: A list of Allocation resources. + type: object + kind: + default: compute#reservationAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ReservationList: + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + description: '[Output Only] A list of Allocation resources.' + items: + $ref: '#/components/schemas/Reservation' + type: array + kind: + default: compute#reservationList + description: '[Output Only] Type of resource.Always compute#reservationsList + for listsof reservations' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ReservationsResizeRequest: + properties: + specificSkuCount: + description: Number of allocated resources can be resized with minimum = + 1 and maximum = 1000. + format: int64 + type: string + type: object + ReservationsScopedList: + properties: + reservations: + description: A list of reservations contained in this scope. + items: + $ref: '#/components/schemas/Reservation' + type: array + warning: + description: Informational warning which replaces the list of reservations + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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). + 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 and MEMORY + enum: + - ACCELERATOR + - LOCAL_SSD + - MEMORY + - UNSPECIFIED + - VCPU + type: string + type: object + 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: + properties: + resourcePolicies: + description: A list of resourcePolicies contained in this scope. + items: + $ref: '#/components/schemas/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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ResourcePolicy: + description: Represents a Resource Policy resource. You can use resource policies + to schedule actions for some Compute Engine resources. For example, you can + use them to schedule persistent disk snapshots. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + type: string + groupPlacementPolicy: + $ref: '#/components/schemas/ResourcePolicyGroupPlacementPolicy' + description: Resource policy for instances for placement configuration. + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + instanceSchedulePolicy: + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicy' + description: Resource policy for scheduling instance operations. + kind: + default: compute#resourcePolicy + description: '[Output Only] Type of the resource. Always compute#resource_policies + for resource policies.' + type: string + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + region: + type: string + resourceStatus: + $ref: '#/components/schemas/ResourcePolicyResourceStatus' + description: '[Output Only] The system status of the resource policy.' + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this + resource.' + type: string + snapshotSchedulePolicy: + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicy' + description: Resource policy for persistent disks for creating snapshots. + status: + description: '[Output Only] The status of resource policy creation.' + enum: + - CREATING + - DELETING + - EXPIRED + - INVALID + - READY + type: string + type: object + ResourcePolicyAggregatedList: + description: Contains a list of resourcePolicies. + properties: + etag: + type: string + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/ResourcePoliciesScopedList' + description: Name of the scope containing this set of resourcePolicies. + description: A list of ResourcePolicy resources. + type: object + kind: + default: compute#resourcePolicyAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ResourcePolicyDailyCycle: + description: Time window specified for daily operations. + properties: + daysInCycle: + description: Defines a schedule with units measured in months. The value + determines how many months pass between the start of each cycle. + format: int32 + type: integer + duration: + description: '[Output only] A predetermined duration for the window, automatically + chosen to be the smallest possible in the given scenario.' + type: string + startTime: + description: Start time of the window. This must be in UTC format that resolves + to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both + 13:00-5 and 08:00 are valid. + type: string + type: object + ResourcePolicyGroupPlacementPolicy: + description: A GroupPlacementPolicy specifies resource placement configuration. + It specifies the failure bucket separation as well as network locality + properties: + availabilityDomainCount: + description: The number of availability domains instances will be spread + across. If two instances are in different availability domain, they will + not be put in the same low latency network + format: int32 + type: integer + collocation: + description: Specifies network collocation + enum: + - COLLOCATED + - UNSPECIFIED_COLLOCATION + type: string + vmCount: + description: Number of vms in this placement group + format: int32 + type: integer + type: object + ResourcePolicyHourlyCycle: + description: Time window specified for hourly operations. + properties: + duration: + description: '[Output only] Duration of the time window, automatically chosen + to be smallest possible in the given scenario.' + type: string + hoursInCycle: + description: Defines a schedule with units measured in hours. The value + determines how many hours pass between the start of each cycle. + format: int32 + type: integer + startTime: + description: 'Time within the window to start the operations. It must be + in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.' + type: string + type: object + ResourcePolicyInstanceSchedulePolicy: + description: An InstanceSchedulePolicy specifies when and how frequent certain + operations are performed on the instance. + properties: + expirationTime: + description: The expiration time of the schedule. The timestamp is an RFC3339 + string. + type: string + startTime: + description: The start time of the schedule. The timestamp is an RFC3339 + string. + type: string + timeZone: + description: 'Specifies the time zone to be used in interpreting Schedule.schedule. + The value of this field must be a time zone name from the tz database: + http://en.wikipedia.org/wiki/Tz_database.' + type: string + vmStartSchedule: + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicySchedule' + description: Specifies the schedule for starting instances. + vmStopSchedule: + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicySchedule' + description: Specifies the schedule for stopping instances. + type: object + ResourcePolicyInstanceSchedulePolicySchedule: + description: Schedule for an instance operation. + properties: + schedule: + description: Specifies the frequency for the operation, using the unix-cron + format. + type: string + type: object + ResourcePolicyList: + properties: + etag: + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + description: '[Output Only] A list of ResourcePolicy resources.' + items: + $ref: '#/components/schemas/ResourcePolicy' + type: array + kind: + default: compute#resourcePolicyList + description: '[Output Only] Type of resource.Always compute#resourcePoliciesList + for listsof resourcePolicies' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ResourcePolicyResourceStatus: + description: Contains output only fields. Use this sub-message for all output + fields set on ResourcePolicy. The internal structure of this "status" field + should mimic the structure of ResourcePolicy proto specification. + properties: + instanceSchedulePolicy: + $ref: '#/components/schemas/ResourcePolicyResourceStatusInstanceSchedulePolicyStatus' + description: '[Output Only] Specifies a set of output values reffering to + the instance_schedule_policy system status. This field should have the + same name as corresponding policy field.' + type: object + ResourcePolicyResourceStatusInstanceSchedulePolicyStatus: + properties: + lastRunStartTime: + description: '[Output Only] The last time the schedule successfully ran. + The timestamp is an RFC3339 string.' + type: string + nextRunStartTime: + description: '[Output Only] The next time the schedule is planned to run. + The actual time might be slightly different. The timestamp is an RFC3339 + string.' + type: string + type: object + ResourcePolicySnapshotSchedulePolicy: + description: A snapshot schedule policy specifies when and how frequently snapshots + are to be created for the target disk. Also specifies how many and how long + these scheduled snapshots should be retained. + properties: + retentionPolicy: + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicyRetentionPolicy' + description: Retention policy applied to snapshots created by this resource + policy. + schedule: + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicySchedule' + description: A Vm Maintenance Policy specifies what kind of infrastructure + maintenance we are allowed to perform on this VM and when. Schedule that + is applied to disks covered by this policy. + snapshotProperties: + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicySnapshotProperties' + description: Properties with which snapshots are created such as labels, + encryption keys. + type: object + ResourcePolicySnapshotSchedulePolicyRetentionPolicy: + description: Policy for retention of scheduled snapshots. + properties: + maxRetentionDays: + description: Maximum age of the snapshot that is allowed to be kept. + format: int32 + type: integer + onSourceDiskDelete: + description: Specifies the behavior to apply to scheduled snapshots when + the source disk is deleted. + enum: + - APPLY_RETENTION_POLICY + - KEEP_AUTO_SNAPSHOTS + - UNSPECIFIED_ON_SOURCE_DISK_DELETE + type: string + type: object + ResourcePolicySnapshotSchedulePolicySchedule: + description: A schedule for disks where the schedueled operations are performed. + properties: + dailySchedule: + $ref: '#/components/schemas/ResourcePolicyDailyCycle' + hourlySchedule: + $ref: '#/components/schemas/ResourcePolicyHourlyCycle' + weeklySchedule: + $ref: '#/components/schemas/ResourcePolicyWeeklyCycle' + type: object + ResourcePolicySnapshotSchedulePolicySnapshotProperties: + description: Specified snapshot properties for scheduled snapshots created by + this policy. + properties: + chainName: + description: Chain name that the snapshot is created in. + type: string + guestFlush: + description: Indication to perform a 'guest aware' snapshot. + type: boolean + labels: + additionalProperties: + type: string + description: Labels to apply to scheduled snapshots. These can be later + modified by the setLabels method. Label values may be empty. + type: object + storageLocations: + description: Cloud Storage bucket storage location of the auto snapshot + (regional or multi-regional). + items: + type: string + type: array + type: object + ResourcePolicyWeeklyCycle: + description: Time window specified for weekly operations. + properties: + dayOfWeeks: + description: Up to 7 intervals/windows, one for each day of the week. + items: + $ref: '#/components/schemas/ResourcePolicyWeeklyCycleDayOfWeek' + type: array + type: object + ResourcePolicyWeeklyCycleDayOfWeek: + properties: + day: + description: 'Defines a schedule that runs on specific days of the week. + Specify one or more days. The following options are available: MONDAY, + TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.' + enum: + - FRIDAY + - INVALID + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY + type: string + duration: + description: '[Output only] Duration of the time window, automatically chosen + to be smallest possible in the given scenario.' + type: string + startTime: + description: 'Time within the window to start the operations. It must be + in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.' + type: string + type: object + Route: + description: Represents a Route resource. A route defines a path from VM instances + in the VPC network to a specific destination. This destination can be inside + or outside the VPC network. For more information, read the Routes overview. + properties: + asPaths: + description: '[Output Only] AS path.' + items: + $ref: '#/components/schemas/RouteAsPath' + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this field + when you create the resource. + type: string + destRange: + description: The destination range of outgoing packets that this route applies + to. Both IPv4 and IPv6 are supported. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#route + description: '[Output Only] Type of this resource. Always compute#routes + for Route resources.' + type: string + name: + description: 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])?`. The first character must be a + lowercase letter, and all following characters (except for the last character) + must be a dash, lowercase letter, or digit. The last character must be + a lowercase letter or digit. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: Fully-qualified URL of the network that this route applies + to. + type: string + nextHopGateway: + description: 'The URL to a gateway that should handle matching packets. + You can only specify the internet gateway using a full or partial valid + URL: projects/ project/global/gateways/default-internet-gateway' + type: string + nextHopIlb: + description: 'The URL to a forwarding rule of type loadBalancingScheme=INTERNAL + that should handle matching packets or the IP address of the forwarding + Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region + /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule ' + type: string + nextHopInstance: + description: 'The URL to an instance that should handle matching packets. + You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/' + type: string + nextHopIp: + description: The network IP address of an instance that should handle matching + packets. Only IPv4 is supported. + type: string + nextHopNetwork: + description: The URL of the local network if it should handle matching packets. + type: string + nextHopPeering: + description: '[Output Only] The network peering name that should handle + matching packets, which should conform to RFC1035.' + type: string + nextHopVpnTunnel: + description: The URL to a VpnTunnel that should handle matching packets. + type: string + priority: + description: The priority of this route. Priority is used to break ties + in cases where there is more than one matching route of equal prefix length. + In cases where multiple routes have equal prefix length, the one with + the lowest-numbered priority value wins. The default value is `1000`. + The priority value must be from `0` to `65535`, inclusive. + format: uint32 + type: integer + routeType: + description: '[Output Only] The type of this route, which can be one of + the following values: - ''TRANSIT'' for a transit route that this router + learned from another Cloud Router and will readvertise to one of its BGP + peers - ''SUBNET'' for a route from a subnet of the VPC - ''BGP'' for + a route learned from a BGP peer of this router - ''STATIC'' for a static + route' + enum: + - BGP + - STATIC + - SUBNET + - TRANSIT + type: string + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this + resource.' + type: string + tags: + description: A list of instance tags to which this route applies. + items: + type: string + type: array + warnings: + description: '[Output Only] If potential misconfigurations are detected + for this route, this field will be populated with warning messages.' + items: + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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: array + type: object + RouteAsPath: + properties: + asLists: + description: '[Output Only] The AS numbers of the AS Path.' + items: + format: uint32 + type: integer + type: array + pathSegmentType: + description: '[Output Only] The type of the AS Path, which can be one of + the following values: - ''AS_SET'': unordered set of autonomous systems + that the route in has traversed - ''AS_SEQUENCE'': ordered set of autonomous + systems that the route has traversed - ''AS_CONFED_SEQUENCE'': ordered + set of Member Autonomous Systems in the local confederation that the route + has traversed - ''AS_CONFED_SET'': unordered set of Member Autonomous + Systems in the local confederation that the route has traversed ' + enum: + - AS_CONFED_SEQUENCE + - AS_CONFED_SET + - AS_SEQUENCE + - AS_SET + type: string + type: object + RouteList: + description: Contains a list of Route resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Route resources. + items: + $ref: '#/components/schemas/Route' + type: array + kind: + default: compute#routeList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Router: + description: Represents a Cloud Router resource. For more information about + Cloud Router, read the Cloud Router overview. + properties: + bgp: + $ref: '#/components/schemas/RouterBgp' + description: BGP information specific to this router. + bgpPeers: + description: BGP information that must be configured into the routing stack + to establish BGP peering. This information must specify the peer ASN and + either the interface name, IP address, or peer IP address. Please refer + to RFC4273. + items: + $ref: '#/components/schemas/RouterBgpPeer' + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + encryptedInterconnectRouter: + description: 'Indicates if a router is dedicated for use with encrypted + VLAN attachments (interconnectAttachments). Not currently available publicly. ' + type: boolean + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + interfaces: + description: Router interfaces. Each interface requires either one linked + resource, (for example, linkedVpnTunnel), or IP address and IP address + range (for example, ipRange), or both. + items: + $ref: '#/components/schemas/RouterInterface' + type: array + kind: + default: compute#router + description: '[Output Only] Type of resource. Always compute#router for + routers.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + nats: + description: A list of NAT services created in this router. + items: + $ref: '#/components/schemas/RouterNat' + type: array + network: + description: URI of the network to which this router belongs. + type: string + region: + description: '[Output Only] URI of the region where the router resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + RouterAdvertisedIpRange: + description: Description-tagged IP ranges for the router to advertise. + properties: + description: + description: User-specified description for the IP range. + type: string + range: + description: The IP range to advertise. The value must be a CIDR-formatted + string. + type: string + type: object + RouterAggregatedList: + description: Contains a list of routers. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/RoutersScopedList' + description: Name of the scope containing this set of routers. + description: A list of Router resources. + type: object + kind: + default: compute#routerAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RouterBgp: + properties: + advertiseMode: + description: User-specified flag to indicate which mode to use for advertisement. + The options are DEFAULT or CUSTOM. + enum: + - CUSTOM + - DEFAULT + type: string + advertisedGroups: + description: User-specified list of prefix groups to advertise in custom + mode. This field can only be populated if advertise_mode is CUSTOM and + is advertised to all peers of the router. These groups will be advertised + in addition to any specified prefixes. Leave this field blank to advertise + no custom groups. + items: + enum: + - ALL_SUBNETS + type: string + type: array + advertisedIpRanges: + description: User-specified list of individual IP ranges to advertise in + custom mode. This field can only be populated if advertise_mode is CUSTOM + and is advertised to all peers of the router. These IP ranges will be + advertised in addition to any specified groups. Leave this field blank + to advertise no custom IP ranges. + items: + $ref: '#/components/schemas/RouterAdvertisedIpRange' + type: array + asn: + description: Local BGP Autonomous System Number (ASN). Must be an RFC6996 + private ASN, either 16-bit or 32-bit. The value will be fixed for this + router resource. All VPN tunnels that link to this router will have the + same local ASN. + format: uint32 + type: integer + keepaliveInterval: + description: The interval in seconds between BGP keepalive messages that + are sent to the peer. Hold time is three times the interval at which keepalive + messages are sent, and the hold time is the maximum number of seconds + allowed to elapse between successive keepalive messages that BGP receives + from a peer. BGP will use the smaller of either the local hold time value + or the peer's hold time value as the hold time for the BGP connection + between the two peers. If set, this value must be between 20 and 60. The + default is 20. + format: uint32 + type: integer + type: object + RouterBgpPeer: + properties: + advertiseMode: + description: User-specified flag to indicate which mode to use for advertisement. + enum: + - CUSTOM + - DEFAULT + type: string + advertisedGroups: + description: 'User-specified list of prefix groups to advertise in custom + mode, which can take one of the following options: - ALL_SUBNETS: Advertises + all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: + Advertises the router''s own VPC subnets. Note that this field can only + be populated if advertise_mode is CUSTOM and overrides the list defined + for the router (in the "bgp" message). These groups are advertised in + addition to any specified prefixes. Leave this field blank to advertise + no custom groups.' + items: + enum: + - ALL_SUBNETS + type: string + type: array + advertisedIpRanges: + description: User-specified list of individual IP ranges to advertise in + custom mode. This field can only be populated if advertise_mode is CUSTOM + and overrides the list defined for the router (in the "bgp" message). + These IP ranges are advertised in addition to any specified groups. Leave + this field blank to advertise no custom IP ranges. + items: + $ref: '#/components/schemas/RouterAdvertisedIpRange' + type: array + advertisedRoutePriority: + description: The priority of routes advertised to this BGP peer. Where there + is more than one matching route of maximum length, the routes with the + lowest priority value win. + format: uint32 + type: integer + bfd: + $ref: '#/components/schemas/RouterBgpPeerBfd' + description: BFD configuration for the BGP peering. + enable: + description: The status of the BGP peer connection. If set to FALSE, any + active session with the peer is terminated and all associated routing + information is removed. If set to TRUE, the peer connection can be established + with routing information. The default is TRUE. + enum: + - 'FALSE' + - 'TRUE' + type: string + interfaceName: + description: Name of the interface the BGP peer is associated with. + type: string + ipAddress: + description: IP address of the interface inside Google Cloud Platform. Only + IPv4 is supported. + type: string + managementType: + description: '[Output Only] The resource that configures and manages this + BGP peer. - MANAGED_BY_USER is the default value and can be managed by + you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured + and managed by Cloud Interconnect, specifically by an InterconnectAttachment + of type PARTNER. Google automatically creates, updates, and deletes this + type of BGP peer when the PARTNER InterconnectAttachment is created, updated, + or deleted. ' + enum: + - MANAGED_BY_ATTACHMENT + - MANAGED_BY_USER + type: string + name: + description: Name of this BGP peer. 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 + peerAsn: + description: Peer BGP Autonomous System Number (ASN). Each BGP interface + may use a different value. + format: uint32 + type: integer + peerIpAddress: + description: IP address of the BGP interface outside Google Cloud Platform. + Only IPv4 is supported. + type: string + routerApplianceInstance: + description: URI of the VM instance that is used as third-party router appliances + such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The + VM instance must be located in zones contained in the same region as this + Cloud Router. The VM instance is the peer side of the BGP session. + type: string + type: object + RouterBgpPeerBfd: + properties: + minReceiveInterval: + description: The minimum interval, in milliseconds, between BFD control + packets received from the peer router. The actual value is negotiated + between the two routers and is equal to the greater of this value and + the transmit interval of the other router. If set, this value must be + between 1000 and 30000. The default is 1000. + format: uint32 + type: integer + minTransmitInterval: + description: The minimum interval, in milliseconds, between BFD control + packets transmitted to the peer router. The actual value is negotiated + between the two routers and is equal to the greater of this value and + the corresponding receive interval of the other router. If set, this value + must be between 1000 and 30000. The default is 1000. + format: uint32 + type: integer + multiplier: + description: The number of consecutive BFD packets that must be missed before + BFD declares that a peer is unavailable. If set, the value must be a value + between 5 and 16. The default is 5. + format: uint32 + type: integer + sessionInitializationMode: + description: The BFD session initialization mode for this BGP peer. If set + to ACTIVE, the Cloud Router will initiate the BFD session for this BGP + peer. If set to PASSIVE, the Cloud Router will wait for the peer router + to initiate the BFD session for this BGP peer. If set to DISABLED, BFD + is disabled for this BGP peer. The default is PASSIVE. + enum: + - ACTIVE + - DISABLED + - PASSIVE + type: string + type: object + RouterInterface: + properties: + ipRange: + description: 'IP address and range of the interface. The IP range must be + in the RFC3927 link-local IP address space. The value must be a CIDR-formatted + string, for example: 169.254.0.1/30. NOTE: Do not truncate the address + as it represents the IP address of the interface.' + type: string + linkedInterconnectAttachment: + description: URI of the linked Interconnect attachment. It must be in the + same region as the router. Each interface can have one linked resource, + which can be a VPN tunnel, an Interconnect attachment, or a virtual machine + instance. + type: string + linkedVpnTunnel: + description: URI of the linked VPN tunnel, which must be in the same region + as the router. Each interface can have one linked resource, which can + be a VPN tunnel, an Interconnect attachment, or a virtual machine instance. + type: string + managementType: + description: '[Output Only] The resource that configures and manages this + interface. - MANAGED_BY_USER is the default value and can be managed directly + by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and + managed by Cloud Interconnect, specifically, by an InterconnectAttachment + of type PARTNER. Google automatically creates, updates, and deletes this + type of interface when the PARTNER InterconnectAttachment is created, + updated, or deleted. ' + enum: + - MANAGED_BY_ATTACHMENT + - MANAGED_BY_USER + type: string + name: + description: Name of this interface entry. 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 + privateIpAddress: + description: The regional private internal IP address that is used to establish + BGP sessions to a VM instance acting as a third-party Router Appliance, + such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM. + type: string + redundantInterface: + description: Name of the interface that will be redundant with the current + interface you are creating. The redundantInterface must belong to the + same Cloud Router as the interface here. To establish the BGP session + to a Router Appliance VM, you must create two BGP peers. The two BGP peers + must be attached to two separate interfaces that are redundant with each + other. The redundant_interface must be 1-63 characters long, and comply + with RFC1035. Specifically, the redundant_interface 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 + subnetwork: + description: The URI of the subnetwork resource that this interface belongs + to, which must be in the same region as the Cloud Router. When you establish + a BGP session to a VM instance using this interface, the VM instance must + belong to the same subnetwork as the subnetwork specified here. + type: string + type: object + RouterList: + description: Contains a list of Router resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Router resources. + items: + $ref: '#/components/schemas/Router' + type: array + kind: + default: compute#routerList + description: '[Output Only] Type of resource. Always compute#router for + routers.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RouterNat: + description: Represents a Nat resource. It enables the VMs within the specified + subnetworks to access Internet without external IP addresses. It specifies + a list of subnetworks (and the ranges within) that want to use NAT. Customers + can also provide the external IPs that would be used for NAT. GCP would auto-allocate + ephemeral IPs if no external IPs are provided. + properties: + drainNatIps: + 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 only. + items: + type: string + type: array + enableEndpointIndependentMapping: + type: boolean + icmpIdleTimeoutSec: + description: Timeout (in seconds) for ICMP connections. Defaults to 30s + if not set. + format: int32 + type: integer + logConfig: + $ref: '#/components/schemas/RouterNatLogConfig' + description: Configure logging on this NAT. + minPortsPerVm: + description: Minimum number of ports allocated to a VM from this NAT config. + If not set, a default number of ports is allocated to a VM. This is rounded + up to the nearest power of 2. For example, if the value of this field + is 50, at least 64 ports are allocated to a VM. + format: int32 + type: integer + name: + description: Unique name of this Nat service. 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 + natIpAllocateOption: + description: 'Specify the NatIpAllocateOption, which can take one of the + following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by + customers. When there are not enough specified Nat IPs, the Nat service + fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud + Platform; customers can''t specify any Nat IPs. When choosing AUTO_ONLY, + then nat_ip should be empty. ' + enum: + - AUTO_ONLY + - MANUAL_ONLY + type: string + natIps: + description: A list of URLs of the IP resources used for this Nat service. + These IP addresses must be valid static external IP addresses assigned + to the project. + items: + type: string + type: array + rules: + description: A list of rules associated with this NAT. + items: + $ref: '#/components/schemas/RouterNatRule' + type: array + sourceSubnetworkIpRangesToNat: + description: 'Specify the Nat option, which can take one of the following + values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every + Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: + All of the primary IP ranges in every Subnetwork are allowed to Nat. - + LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified + in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. + Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, + then there should not be any other Router.Nat section in any Router for + this network in this region.' + enum: + - ALL_SUBNETWORKS_ALL_IP_RANGES + - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES + - LIST_OF_SUBNETWORKS + type: string + subnetworks: + description: A list of Subnetwork resources whose traffic should be translated + by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for + the SubnetworkIpRangeToNatOption above. + items: + $ref: '#/components/schemas/RouterNatSubnetworkToNat' + type: array + tcpEstablishedIdleTimeoutSec: + description: Timeout (in seconds) for TCP established connections. Defaults + to 1200s if not set. + format: int32 + type: integer + tcpTimeWaitTimeoutSec: + description: Timeout (in seconds) for TCP connections that are in TIME_WAIT + state. Defaults to 120s if not set. + format: int32 + type: integer + tcpTransitoryIdleTimeoutSec: + description: Timeout (in seconds) for TCP transitory connections. Defaults + to 30s if not set. + format: int32 + type: integer + udpIdleTimeoutSec: + description: Timeout (in seconds) for UDP connections. Defaults to 30s if + not set. + format: int32 + type: integer + type: object + RouterNatLogConfig: + description: Configuration of logging on a NAT. + properties: + enable: + description: Indicates whether or not to export logs. This is false by default. + type: boolean + filter: + description: 'Specify the desired filtering of logs on this NAT. If unspecified, + logs are exported for all connections handled by this NAT. This option + can take one of the following values: - ERRORS_ONLY: Export logs only + for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful + connections. - ALL: Export logs for all connections, successful and unsuccessful. ' + enum: + - ALL + - ERRORS_ONLY + - TRANSLATIONS_ONLY + type: string + type: object + RouterNatRule: + properties: + action: + $ref: '#/components/schemas/RouterNatRuleAction' + description: The action to be enforced for traffic that matches this rule. + description: + description: An optional description of this rule. + type: string + match: + description: '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 + == ''/projects/my-project/global/hub/hub-1''"' + type: string + ruleNumber: + description: An integer uniquely identifying a rule in the list. The rule + number must be a positive value between 0 and 65000, and must be unique + among rules within a NAT. + format: uint32 + type: integer + type: object + RouterNatRuleAction: + properties: + sourceNatActiveIps: + description: 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. + 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 + type: object + RouterNatSubnetworkToNat: + description: Defines the IP ranges that want to use NAT for a subnetwork. + properties: + name: + description: URL for the subnetwork resource that will use NAT. + type: string + secondaryIpRangeNames: + description: A list of the secondary ranges of the Subnetwork that are allowed + to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" + is one of the values in source_ip_ranges_to_nat. + items: + type: string + type: array + sourceIpRangesToNat: + description: 'Specify the options for NAT ranges in the Subnetwork. All + options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. + The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] + Default: [ALL_IP_RANGES]' + items: + enum: + - ALL_IP_RANGES + - LIST_OF_SECONDARY_IP_RANGES + - PRIMARY_IP_RANGE + type: string + type: array + type: object + RouterStatus: + properties: + bestRoutes: + description: Best routes for this router's network. + items: + $ref: '#/components/schemas/Route' + type: array + bestRoutesForRouter: + description: Best routes learned by this router. + items: + $ref: '#/components/schemas/Route' + type: array + bgpPeerStatus: + items: + $ref: '#/components/schemas/RouterStatusBgpPeerStatus' + type: array + natStatus: + items: + $ref: '#/components/schemas/RouterStatusNatStatus' + type: array + network: + description: URI of the network to which this router belongs. + type: string + type: object + RouterStatusBgpPeerStatus: + properties: + advertisedRoutes: + description: Routes that were advertised to the remote BGP peer + items: + $ref: '#/components/schemas/Route' + type: array + bfdStatus: + $ref: '#/components/schemas/BfdStatus' + ipAddress: + description: IP address of the local BGP interface. + type: string + linkedVpnTunnel: + description: URL of the VPN tunnel that this BGP peer controls. + type: string + name: + description: Name of this BGP peer. Unique within the Routers resource. + type: string + numLearnedRoutes: + description: Number of routes learned from the remote BGP Peer. + format: uint32 + type: integer + peerIpAddress: + description: IP address of the remote BGP interface. + type: string + routerApplianceInstance: + description: '[Output only] URI of the VM instance that is used as third-party + router appliances such as Next Gen Firewalls, Virtual Routers, or Router + Appliances. The VM instance is the peer side of the BGP session.' + type: string + state: + description: BGP state as specified in RFC1771. + type: string + status: + description: 'Status of the BGP peer: {UP, DOWN}' + enum: + - DOWN + - UNKNOWN + - UP + type: string + uptime: + description: 'Time this session has been up. Format: 14 years, 51 weeks, + 6 days, 23 hours, 59 minutes, 59 seconds' + type: string + uptimeSeconds: + description: 'Time this session has been up, in seconds. Format: 145' + type: string + type: object + RouterStatusNatStatus: + description: Status of a NAT contained in this router. + properties: + autoAllocatedNatIps: + description: 'A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", + "129.2.16.89"]' + items: + type: string + type: array + drainAutoAllocatedNatIps: + description: 'A list of IPs auto-allocated for NAT that are in drain mode. + Example: ["1.1.1.1", "179.12.26.133"].' + items: + type: string + type: array + drainUserAllocatedNatIps: + description: 'A list of IPs user-allocated for NAT that are in drain mode. + Example: ["1.1.1.1", "179.12.26.133"].' + items: + type: string + type: array + minExtraNatIpsNeeded: + description: The number of extra IPs to allocate. This will be greater than + 0 only if user-specified IPs are NOT enough to allow all configured VMs + to use NAT. This value is meaningful only when auto-allocation of NAT + IPs is *not* used. + format: int32 + type: integer + name: + description: Unique name of this NAT. + type: string + numVmEndpointsWithNatMappings: + description: Number of VM endpoints (i.e., Nics) that can use NAT. + format: int32 + type: integer + ruleStatus: + description: Status of rules in this NAT. + items: + $ref: '#/components/schemas/RouterStatusNatStatusNatRuleStatus' + type: array + userAllocatedNatIpResources: + description: A list of fully qualified URLs of reserved IP address resources. + items: + type: string + type: array + userAllocatedNatIps: + description: A list of IPs user-allocated for NAT. They will be raw IP strings + like "179.12.26.133". + items: + type: string + type: array + type: object + RouterStatusNatStatusNatRuleStatus: + description: Status of a NAT Rule contained in this NAT. + properties: + activeNatIps: + description: 'A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].' + items: + type: string + type: array + drainNatIps: + description: 'A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", + "179.12.26.133"].' + items: + type: string + type: array + minExtraIpsNeeded: + description: The number of extra IPs to allocate. This will be greater than + 0 only if the existing IPs in this NAT Rule are NOT enough to allow all + configured VMs to use NAT. + format: int32 + type: integer + numVmEndpointsWithNatMappings: + description: Number of VM endpoints (i.e., NICs) that have NAT Mappings + from this NAT Rule. + format: int32 + type: integer + ruleNumber: + description: Rule number of the rule. + format: int32 + type: integer + type: object + RouterStatusResponse: + properties: + kind: + default: compute#routerStatusResponse + description: Type of resource. + type: string + result: + $ref: '#/components/schemas/RouterStatus' + type: object + RoutersPreviewResponse: + properties: + resource: + $ref: '#/components/schemas/Router' + description: Preview of given router. + type: object + RoutersScopedList: + properties: + routers: + description: A list of routers contained in this scope. + items: + $ref: '#/components/schemas/Router' + type: array + warning: + description: Informational warning which replaces the list of routers 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Rule: + description: This is deprecated and has no effect. Do not use. + properties: + action: + description: This is deprecated and has no effect. Do not use. + enum: + - ALLOW + - ALLOW_WITH_LOG + - DENY + - DENY_WITH_LOG + - LOG + - NO_ACTION + type: string + conditions: + description: This is deprecated and has no effect. Do not use. + items: + $ref: '#/components/schemas/Condition' + type: array + description: + description: This is deprecated and has no effect. Do not use. + type: string + ins: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + logConfigs: + description: This is deprecated and has no effect. Do not use. + items: + $ref: '#/components/schemas/LogConfig' + type: array + notIns: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + permissions: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + type: object + SSLHealthCheck: + properties: + port: + description: The TCP port number for the health check request. The default + value is 443. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, SSL health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + request: + description: The application data to send once the SSL connection has been + established (default value is empty). If both request and response are + empty, the connection establishment alone will indicate health. The request + data can only be ASCII. + type: string + response: + description: The bytes to match against the beginning of the response data. + If left empty (the default value), any response will indicate health. + The response data can only be ASCII. + type: string + type: object + ScalingScheduleStatus: + properties: + lastStartTime: + description: '[Output Only] The last time the scaling schedule became active. + Note: this is a timestamp when a schedule actually became active, not + when it was planned to do so. The timestamp is in RFC3339 text format.' + type: string + nextStartTime: + description: '[Output Only] The next time the scaling schedule is to become + active. Note: this is a timestamp when a schedule is planned to run, but + the actual time might be slightly different. The timestamp is in RFC3339 + text format.' + type: string + state: + description: '[Output Only] The current state of a scaling schedule.' + enum: + - ACTIVE + - DISABLED + - OBSOLETE + - READY + type: string + type: object + Scheduling: + description: 'Sets the scheduling options for an Instance. NextID: 21' + properties: + automaticRestart: + description: Specifies whether the instance should be automatically restarted + if it is terminated by Compute Engine (not terminated by a user). You + can only set the automatic restart option for standard instances. Preemptible + instances cannot be automatically restarted. By default, this is set to + true so an instance is automatically restarted if it is terminated by + Compute Engine. + type: boolean + locationHint: + description: An opaque location hint used to place the instance close to + other resources. This field is for use by internal tools that use the + public API. + type: string + minNodeCpus: + description: The minimum number of virtual CPUs this instance will consume + when running on a sole-tenant node. + format: int32 + type: integer + nodeAffinities: + description: A set of node affinity and anti-affinity configurations. Refer + to Configuring node affinity for more information. Overrides reservationAffinity. + items: + $ref: '#/components/schemas/SchedulingNodeAffinity' + type: array + onHostMaintenance: + description: Defines the maintenance behavior for this instance. For standard + instances, the default behavior is MIGRATE. For preemptible instances, + the default and only possible behavior is TERMINATE. For more information, + see Setting Instance Scheduling Options. + enum: + - MIGRATE + - TERMINATE + type: string + preemptible: + description: Defines whether the instance is preemptible. This can only + be set during instance creation or while the instance is stopped and therefore, + in a `TERMINATED` state. See Instance Life Cycle for more information + on the possible instance states. + type: boolean + type: object + SchedulingNodeAffinity: + description: 'Node Affinity: the configuration of desired nodes onto which this + Instance could be scheduled.' + properties: + key: + description: Corresponds to the label key of Node resource. + type: string + operator: + description: Defines the operation of node selection. Valid operators are + IN for affinity and NOT_IN for anti-affinity. + enum: + - IN + - NOT_IN + - OPERATOR_UNSPECIFIED + type: string + values: + description: Corresponds to the label values of Node resource. + items: + type: string + type: array + type: object + Screenshot: + description: An instance's screenshot. + properties: + contents: + description: '[Output Only] The Base64-encoded screenshot data.' + type: string + kind: + default: compute#screenshot + description: '[Output Only] Type of the resource. Always compute#screenshot + for the screenshots.' + type: string + type: object + SecurityPoliciesListPreconfiguredExpressionSetsResponse: + properties: + preconfiguredExpressionSets: + $ref: '#/components/schemas/SecurityPoliciesWafConfig' + type: object + SecurityPoliciesWafConfig: + properties: + wafRules: + $ref: '#/components/schemas/PreconfiguredWafSet' + type: object + SecurityPolicy: + description: Represents a Google Cloud Armor security policy resource. Only + external backend services that use load balancers can reference a security + policy. For more information, see Google Cloud Armor security policy overview. + properties: + adaptiveProtectionConfig: + $ref: '#/components/schemas/SecurityPolicyAdaptiveProtectionConfig' + advancedOptionsConfig: + $ref: '#/components/schemas/SecurityPolicyAdvancedOptionsConfig' + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Specifies a fingerprint for this resource, which is essentially + a hash of the metadata's contents and used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update metadata. You must always provide an + up-to-date fingerprint hash in order to update or change metadata, otherwise + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make get() request to the security policy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#securityPolicy + description: '[Output only] Type of the resource. Always compute#securityPolicyfor + security policies' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + rules: + description: A list of rules that belong to this policy. There must always + be a default rule (rule with priority 2147483647 and match "*"). If no + rules are provided when creating a security policy, a default rule with + action "allow" will be added. + items: + $ref: '#/components/schemas/SecurityPolicyRule' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + SecurityPolicyAdaptiveProtectionConfig: + description: Configuration options for Cloud Armor Adaptive Protection (CAAP). + properties: + layer7DdosDefenseConfig: + $ref: '#/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig' + description: If set to true, enables Cloud Armor Machine Learning. + type: object + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig: + description: Configuration options for L7 DDoS detection. + properties: + enable: + description: If set to true, enables CAAP for L7 DDoS detection. + type: boolean + ruleVisibility: + description: 'Rule visibility can be one of the following: STANDARD - opaque + rules. (default) PREMIUM - transparent rules.' + enum: + - PREMIUM + - STANDARD + type: string + type: object + SecurityPolicyAdvancedOptionsConfig: + properties: + jsonParsing: + enum: + - DISABLED + - STANDARD + type: string + logLevel: + enum: + - NORMAL + - VERBOSE + type: string + type: object + SecurityPolicyList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of SecurityPolicy resources. + items: + $ref: '#/components/schemas/SecurityPolicy' + type: array + kind: + default: compute#securityPolicyList + description: '[Output Only] Type of resource. Always compute#securityPolicyList + for listsof securityPolicies' + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SecurityPolicyReference: + properties: + securityPolicy: + type: string + type: object + SecurityPolicyRule: + description: Represents a rule that describes one or more match conditions along + with the action to be taken when traffic matches this condition (allow or + deny). + properties: + action: + description: The Action to perform when the client connection triggers the + rule. Can currently be either "allow" or "deny()" where valid values for + status are 403, 404, and 502. + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + kind: + default: compute#securityPolicyRule + description: '[Output only] Type of the resource. Always compute#securityPolicyRule + for security policy rules' + type: string + match: + $ref: '#/components/schemas/SecurityPolicyRuleMatcher' + description: A match condition that incoming traffic is evaluated against. + If it evaluates to true, the corresponding 'action' is enforced. + preview: + description: If set to true, the specified action is not enforced. + type: boolean + priority: + description: An integer indicating the priority of a rule in the list. The + priority must be a positive value between 0 and 2147483647. Rules are + evaluated from highest to lowest priority where 0 is the highest priority + and 2147483647 is the lowest priority. + format: int32 + type: integer + type: object + SecurityPolicyRuleMatcher: + description: Represents a match condition that incoming traffic is evaluated + against. Exactly one field must be specified. + properties: + config: + $ref: '#/components/schemas/SecurityPolicyRuleMatcherConfig' + description: The configuration options available when specifying versioned_expr. + This field must be specified if versioned_expr is specified and cannot + be specified if versioned_expr is not specified. + expr: + $ref: '#/components/schemas/Expr' + description: User defined CEVAL expression. A CEVAL expression is used to + specify match criteria such as origin.ip, source.region_code and contents + in the request header. + versionedExpr: + description: 'Preconfigured versioned expression. If this field is specified, + config must also be specified. Available preconfigured expressions along + with their requirements are: SRC_IPS_V1 - must specify the corresponding + src_ip_range field in config.' + enum: + - SRC_IPS_V1 + type: string + type: object + SecurityPolicyRuleMatcherConfig: + properties: + srcIpRanges: + description: CIDR IP address range. Maximum number of src_ip_ranges allowed + is 10. + items: + type: string + type: array + type: object + SecuritySettings: + description: The authentication and authorization settings for a BackendService. + properties: + clientTlsPolicy: + description: 'Optional. A URL referring to a networksecurity.ClientTlsPolicy + resource that describes how clients should authenticate with this service''s + backends. clientTlsPolicy only applies to a global BackendService with + the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications + are not encrypted. Note: This field currently has no impact.' + type: string + subjectAltNames: + description: 'Optional. A list of Subject Alternative Names (SANs) that + the client verifies during a mutual TLS handshake with an server/endpoint + for this BackendService. When the server presents its X.509 certificate + to the client, the client inspects the certificate''s subjectAltName field. + If the field contains one of the specified values, the communication continues. + Otherwise, it fails. This additional check enables the client to verify + that the server is authorized to run the requested service. Note that + the contents of the server certificate''s subjectAltName field are configured + by the Public Key Infrastructure which provisions server identities. Only + applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. + Only applies when BackendService has an attached clientTlsPolicy with + clientCertificate (mTLS mode). Note: This field currently has no impact.' + items: + type: string + type: array + type: object + SerialPortOutput: + description: An instance serial console output. + properties: + contents: + description: '[Output Only] The contents of the console output.' + type: string + kind: + default: compute#serialPortOutput + description: '[Output Only] Type of the resource. Always compute#serialPortOutput + for serial port output.' + type: string + next: + description: '[Output Only] The position of the next byte of content, regardless + of whether the content exists, following the output returned in the `contents` + property. Use this value in the next request as the start parameter.' + format: int64 + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + start: + description: The starting byte position of the output that was returned. + This should match the start parameter sent with the request. If the serial + console output exceeds the size of the buffer (1 MB), older output is + overwritten by newer content. The output start value will indicate the + byte position of the output that was returned, which might be different + than the `start` value that was specified in the request. + format: int64 + type: string + type: object + ServerBinding: + properties: + type: + enum: + - RESTART_NODE_ON_ANY_SERVER + - RESTART_NODE_ON_MINIMAL_SERVERS + - SERVER_BINDING_TYPE_UNSPECIFIED + type: string + type: object + ServiceAccount: + description: A service account. + properties: + email: + description: Email address of the service account. + type: string + scopes: + description: The list of scopes to be made available for this service account. + items: + type: string + type: array + type: object + ServiceAttachment: + description: Represents a ServiceAttachment resource. A service attachment represents + a service that a producer has exposed. It encapsulates the load balancer which + fronts the service runs and a list of NAT IP ranges that the producers uses + to represent the consumers connecting to the service. next tag = 20 + properties: + connectedEndpoints: + description: '[Output Only] An array of connections for all the consumers + connected to this service attachment.' + items: + $ref: '#/components/schemas/ServiceAttachmentConnectedEndpoint' + type: array + connectionPreference: + description: The connection preference of service attachment. The value + can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment + is one that always accepts the connection from consumer forwarding rules. + enum: + - ACCEPT_AUTOMATIC + - ACCEPT_MANUAL + - CONNECTION_PREFERENCE_UNSPECIFIED + type: string + consumerAcceptLists: + description: Projects that are allowed to connect to this service attachment. + items: + $ref: '#/components/schemas/ServiceAttachmentConsumerProjectLimit' + type: array + consumerRejectLists: + description: Projects that are not allowed to connect to this service attachment. + The project can be specified using its id or number. + items: + type: string + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + enableProxyProtocol: + description: If true, enable the proxy protocol which is for supplying client + TCP/IP address data in TCP connections that traverse proxies on their + way to destination servers. + type: boolean + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a ServiceAttachment. An up-to-date fingerprint + must be provided in order to patch/update the ServiceAttachment; otherwise, + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the ServiceAttachment. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource type. + The server generates this identifier.' + format: uint64 + type: string + kind: + default: compute#serviceAttachment + description: '[Output Only] Type of the resource. Always compute#serviceAttachment + for service attachments.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + natSubnets: + description: An array of URLs where each entry is the URL of a subnet provided + by the service producer to use for NAT in this service attachment. + items: + type: string + type: array + producerForwardingRule: + description: The URL of a forwarding rule with loadBalancingScheme INTERNAL* + that is serving the endpoint identified by this service attachment. + type: string + pscServiceAttachmentId: + $ref: '#/components/schemas/Uint128' + description: '[Output Only] An 128-bit global unique ID of the PSC service + attachment.' + region: + description: '[Output Only] URL of the region where the service attachment + resides. This field applies only to the region resource. You must specify + this field as part of the HTTP request URL. It is not settable as a field + in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + targetService: + description: The URL of a service serving the endpoint identified by this + service attachment. + type: string + type: object + ServiceAttachmentAggregatedList: + description: Contains a list of ServiceAttachmentsScopedList. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/ServiceAttachmentsScopedList' + description: Name of the scope containing this set of ServiceAttachments. + description: A list of ServiceAttachmentsScopedList resources. + type: object + kind: + default: compute#serviceAttachmentAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ServiceAttachmentConnectedEndpoint: + description: '[Output Only] A connection connected to this service attachment.' + properties: + endpoint: + description: The url of a connected endpoint. + type: string + pscConnectionId: + description: The PSC connection id of the connected endpoint. + format: uint64 + type: string + status: + description: The status of a connected endpoint to this service attachment. + enum: + - ACCEPTED + - CLOSED + - PENDING + - REJECTED + - STATUS_UNSPECIFIED + type: string + type: object + ServiceAttachmentConsumerProjectLimit: + properties: + connectionLimit: + description: The value of the limit to set. + format: uint32 + type: integer + projectIdOrNum: + description: The project id or number for the project to set the limit for. + type: string + type: object + ServiceAttachmentList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of ServiceAttachment resources. + items: + $ref: '#/components/schemas/ServiceAttachment' + type: array + kind: + default: compute#serviceAttachmentList + description: '[Output Only] Type of the resource. Always compute#serviceAttachment + for service attachments.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ServiceAttachmentsScopedList: + properties: + serviceAttachments: + description: A list of ServiceAttachments contained in this scope. + items: + $ref: '#/components/schemas/ServiceAttachment' + type: array + warning: + description: Informational warning which replaces the list of service attachments + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ShareSettings: + description: The share setting for reservations and sole tenancy node groups. + properties: + shareType: + description: Type of sharing for this shared-reservation + enum: + - LOCAL + - SHARE_TYPE_UNSPECIFIED + type: string + type: object + ShieldedInstanceConfig: + description: A set of Shielded Instance options. + properties: + enableIntegrityMonitoring: + description: Defines whether the instance has integrity monitoring enabled. + Enabled by default. + type: boolean + enableSecureBoot: + description: Defines whether the instance has Secure Boot enabled. Disabled + by default. + type: boolean + enableVtpm: + description: Defines whether the instance has the vTPM enabled. Enabled + by default. + type: boolean + type: object + ShieldedInstanceIdentity: + description: A Shielded Instance Identity. + properties: + encryptionKey: + $ref: '#/components/schemas/ShieldedInstanceIdentityEntry' + description: An Endorsement Key (EK) made by the RSA 2048 algorithm issued + to the Shielded Instance's vTPM. + kind: + default: compute#shieldedInstanceIdentity + description: '[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity + for shielded Instance identity entry.' + type: string + signingKey: + $ref: '#/components/schemas/ShieldedInstanceIdentityEntry' + description: An Attestation Key (AK) made by the RSA 2048 algorithm issued + to the Shielded Instance's vTPM. + type: object + ShieldedInstanceIdentityEntry: + description: A Shielded Instance Identity Entry. + properties: + ekCert: + description: A PEM-encoded X.509 certificate. This field can be empty. + type: string + ekPub: + description: A PEM-encoded public key. + type: string + type: object + ShieldedInstanceIntegrityPolicy: + description: The policy describes the baseline against which Instance boot integrity + is measured. + properties: + updateAutoLearnPolicy: + description: Updates the integrity policy baseline using the measurements + from the VM instance's most recent boot. + type: boolean + type: object + SignedUrlKey: + description: Represents a customer-supplied Signing Key used by Cloud CDN Signed + URLs + properties: + keyName: + description: Name of the 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + keyValue: + description: 128-bit key value used for signing the URL. The key value must + be a valid RFC 4648 Section 5 base64url encoded string. + type: string + type: object + Snapshot: + description: Represents a Persistent Disk Snapshot resource. You can use snapshots + to back up data on a regular interval. For more information, read Creating + persistent disk snapshots. + properties: + autoCreated: + description: '[Output Only] Set to true if snapshots are automatically created + by applying resource policy on the target disk.' + type: boolean + chainName: + description: Creates the new snapshot in the snapshot chain labeled with + the specified name. The chain name must be 1-63 characters long and comply + with RFC1035. This is an uncommon option only for advanced service owners + who needs to create separate snapshot chains, for example, for chargeback + tracking. When you describe your snapshot resource, this field is visible + only if it has a non-empty value. + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + diskSizeGb: + description: '[Output Only] Size of the source disk, specified in GB.' + format: int64 + type: string + downloadBytes: + description: '[Output Only] Number of bytes downloaded to restore a snapshot + to a disk.' + format: int64 + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#snapshot + description: '[Output Only] Type of the resource. Always compute#snapshot + for Snapshot resources.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this snapshot, + which is essentially a hash of the labels set used for optimistic locking. + The fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve a snapshot. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this snapshot. These can be later modified + by the setLabels method. Label values may be empty. + type: object + licenseCodes: + description: '[Output Only] Integer license codes indicating which licenses + are attached to this snapshot.' + items: + format: int64 + type: string + type: array + licenses: + description: '[Output Only] A list of public visible licenses that apply + to this snapshot. This can be because the original image had licenses + attached (such as a Windows image).' + items: + type: string + type: array + locationHint: + description: An opaque location hint used to place the snapshot close to + other resources. This field is for use by internal tools that use the + public API. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + snapshotEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: Encrypts the snapshot using a customer-supplied encryption + key. After you encrypt a snapshot using a customer-supplied key, you must + provide the same key if you use the snapshot later. For example, you must + provide the encryption key when you create a disk from the encrypted snapshot + in a future request. Customer-supplied encryption keys do not protect + access to metadata of the snapshot. If you do not provide an encryption + key when creating the snapshot, then the snapshot will be encrypted using + an automatically generated key and you do not need to provide a key to + use the snapshot later. + sourceDisk: + description: The source disk used to create this snapshot. + type: string + sourceDiskEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source disk. Required + if the source disk is protected by a customer-supplied encryption key. + sourceDiskId: + description: '[Output Only] The ID value of the disk used to create this + snapshot. This value may be used to determine whether the snapshot was + taken from the current or a previous instance of a given disk name.' + type: string + status: + description: '[Output Only] The status of the snapshot. This can be CREATING, + DELETING, FAILED, READY, or UPLOADING.' + enum: + - CREATING + - DELETING + - FAILED + - READY + - UPLOADING + type: string + storageBytes: + description: '[Output Only] A size of the storage used by the snapshot. + As snapshots share storage, this number is expected to change with snapshot + creation/deletion.' + format: int64 + type: string + storageBytesStatus: + description: '[Output Only] An indicator whether storageBytes is in a stable + state or it is being adjusted as a result of shared storage reallocation. + This status can either be UPDATING, meaning the size of the snapshot is + being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.' + enum: + - UPDATING + - UP_TO_DATE + type: string + storageLocations: + description: Cloud Storage bucket storage location of the snapshot (regional + or multi-regional). + items: + type: string + type: array + type: object + SnapshotList: + description: Contains a list of Snapshot resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Snapshot resources. + items: + $ref: '#/components/schemas/Snapshot' + type: array + kind: + default: compute#snapshotList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SourceInstanceParams: + description: A specification of the parameters to use when creating the instance + template from a source instance. + properties: + diskConfigs: + description: 'Attached disks configuration. If not provided, defaults are + applied: For boot disk and any other R/W disks, new custom images will + be created from each disk. For read-only disks, they will be attached + in read-only mode. Local SSD disks will be created as blank volumes.' + items: + $ref: '#/components/schemas/DiskInstantiationConfig' + type: array + type: object + SslCertificate: + description: 'Represents an SSL Certificate resource. Google Compute Engine + has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) + * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The sslCertificates + are used by: - external HTTPS load balancers - SSL proxy load balancers The + regionSslCertificates are used by internal HTTPS load balancers. Optionally, + certificate file contents that you upload can contain a set of up to five + PEM-encoded certificates. The API call creates an object (sslCertificate) + that holds this data. You can use SSL keys and certificates to secure connections + to a load balancer. For more information, read Creating and using SSL certificates, + SSL certificates quotas and limits, and Troubleshooting SSL certificates.' + properties: + certificate: + description: A value read into memory from a certificate file. The certificate + file must be in PEM format. The certificate chain must be no greater than + 5 certs long. The chain must include at least one intermediate cert. + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + expireTime: + description: '[Output Only] Expire time of the certificate. RFC3339' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#sslCertificate + description: '[Output Only] Type of the resource. Always compute#sslCertificate + for SSL certificates.' + type: string + managed: + $ref: '#/components/schemas/SslCertificateManagedSslCertificate' + description: Configuration and status of a managed SSL certificate. + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + privateKey: + description: A value read into memory from a write-only private key file. + The private key file must be in PEM format. For security, only insert + requests include this field. + type: string + region: + description: '[Output Only] URL of the region where the regional SSL Certificate + resides. This field is not applicable to global SSL Certificate.' + type: string + selfLink: + description: '[Output only] Server-defined URL for the resource.' + type: string + selfManaged: + $ref: '#/components/schemas/SslCertificateSelfManagedSslCertificate' + description: Configuration and status of a self-managed SSL certificate. + subjectAlternativeNames: + description: '[Output Only] Domains associated with the certificate via + Subject Alternative Name.' + items: + type: string + type: array + type: + description: (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" + or "MANAGED". If not specified, the certificate is self-managed and the + fields certificate and private_key are used. + enum: + - MANAGED + - SELF_MANAGED + - TYPE_UNSPECIFIED + type: string + type: object + SslCertificateAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/SslCertificatesScopedList' + description: Name of the scope containing this set of SslCertificates. + description: A list of SslCertificatesScopedList resources. + type: object + kind: + default: compute#sslCertificateAggregatedList + description: '[Output Only] Type of resource. Always compute#sslCertificateAggregatedList + for lists of SSL Certificates.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SslCertificateList: + description: Contains a list of SslCertificate resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of SslCertificate resources. + items: + $ref: '#/components/schemas/SslCertificate' + type: array + kind: + default: compute#sslCertificateList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SslCertificateManagedSslCertificate: + description: Configuration and status of a managed SSL certificate. + properties: + domainStatus: + additionalProperties: + enum: + - ACTIVE + - DOMAIN_STATUS_UNSPECIFIED + - FAILED_CAA_CHECKING + - FAILED_CAA_FORBIDDEN + - FAILED_NOT_VISIBLE + - FAILED_RATE_LIMITED + - PROVISIONING + type: string + description: '[Output only] Detailed statuses of the domains specified for + managed certificate resource.' + type: object + domains: + description: The domains for which a managed SSL certificate will be generated. + Each Google-managed SSL certificate supports up to the [maximum number + of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates). + items: + type: string + type: array + status: + description: '[Output only] Status of the managed certificate resource.' + enum: + - ACTIVE + - MANAGED_CERTIFICATE_STATUS_UNSPECIFIED + - PROVISIONING + - PROVISIONING_FAILED + - PROVISIONING_FAILED_PERMANENTLY + - RENEWAL_FAILED + type: string + type: object + SslCertificateSelfManagedSslCertificate: + description: Configuration and status of a self-managed SSL certificate. + properties: + certificate: + description: A local certificate file. The certificate must be in PEM format. + The certificate chain must be no greater than 5 certs long. The chain + must include at least one intermediate cert. + type: string + privateKey: + description: A write-only private key in PEM format. Only insert requests + will include this field. + type: string + type: object + SslCertificatesScopedList: + properties: + sslCertificates: + description: List of SslCertificates contained in this scope. + items: + $ref: '#/components/schemas/SslCertificate' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SslPoliciesList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of SslPolicy resources. + items: + $ref: '#/components/schemas/SslPolicy' + type: array + kind: + default: compute#sslPoliciesList + description: '[Output Only] Type of the resource. Always compute#sslPoliciesList + for lists of sslPolicies.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SslPoliciesListAvailableFeaturesResponse: + properties: + features: + items: + type: string + type: array + type: object + SslPolicy: + description: Represents an SSL Policy resource. Use SSL policies to control + the SSL features, such as versions and cipher suites, offered by an HTTPS + or SSL Proxy load balancer. For more information, read SSL Policy Concepts. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customFeatures: + description: A list of features enabled when the selected profile is CUSTOM. + The method returns the set of features that can be specified in this list. + This field must be empty if the profile is not CUSTOM. + items: + type: string + type: array + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + enabledFeatures: + description: '[Output Only] The list of features enabled in the SSL policy.' + items: + type: string + type: array + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a SslPolicy. An up-to-date fingerprint must + be provided in order to update the SslPolicy, otherwise the request will + fail with error 412 conditionNotMet. To see the latest fingerprint, make + a get() request to retrieve an SslPolicy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#sslPolicy + description: '[Output only] Type of the resource. Always compute#sslPolicyfor + SSL policies.' + type: string + minTlsVersion: + description: The minimum version of SSL protocol that can be used by the + clients to establish a connection with the load balancer. This can be + one of TLS_1_0, TLS_1_1, TLS_1_2. + enum: + - TLS_1_0 + - TLS_1_1 + - TLS_1_2 + type: string + name: + description: Name of the resource. 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 + profile: + description: Profile specifies the set of SSL features that can be used + by the load balancer when negotiating SSL with clients. This can be one + of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set + of SSL features to enable must be specified in the customFeatures field. + enum: + - COMPATIBLE + - CUSTOM + - MODERN + - RESTRICTED + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + warnings: + description: '[Output Only] If potential misconfigurations are detected + for this SSL policy, this field will be populated with warning messages.' + items: + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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: array + type: object + SslPolicyReference: + properties: + sslPolicy: + description: URL of the SSL policy resource. Set this to empty string to + clear any existing SSL policy associated with the target proxy resource. + type: string + type: object + StatefulPolicy: + properties: + preservedState: + $ref: '#/components/schemas/StatefulPolicyPreservedState' + type: object + StatefulPolicyPreservedState: + description: Configuration of preserved resources. + properties: + disks: + additionalProperties: + $ref: '#/components/schemas/StatefulPolicyPreservedStateDiskDevice' + description: Disks created on the instances that will be preserved on instance + delete, update, etc. This map is keyed with the device names of the disks. + type: object + type: object + StatefulPolicyPreservedStateDiskDevice: + properties: + autoDelete: + description: 'These stateful disks will never be deleted during autohealing, + update or VM instance recreate operations. This flag is used to configure + if the disk should be deleted after it is no longer used by the group, + e.g. when the given instance or the whole group is deleted. Note: disks + attached in READ_ONLY mode cannot be auto-deleted.' + enum: + - NEVER + - ON_PERMANENT_INSTANCE_DELETION + type: string + type: object + Subnetwork: + description: Represents a Subnetwork resource. A subnetwork (also known as a + subnet) is a logical partition of a Virtual Private Cloud network with one + primary IP range and zero or more secondary IP ranges. For more information, + read Virtual Private Cloud (VPC) Network. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. This field can be set only at resource creation + time. + type: string + enableFlowLogs: + description: Whether to enable flow logging for this subnetwork. If this + field is not explicitly set, it will not appear in get listings. If not + set the default behavior is to disable flow logging. This field isn't + supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER. + type: boolean + externalIpv6Prefix: + description: '[Output Only] The range of external IPv6 addresses that are + owned by this subnetwork.' + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a Subnetwork. An up-to-date fingerprint must + be provided in order to update the Subnetwork, otherwise the request will + fail with error 412 conditionNotMet. To see the latest fingerprint, make + a get() request to retrieve a Subnetwork. + format: byte + type: string + gatewayAddress: + description: '[Output Only] The gateway address for default routes to reach + destination addresses outside this subnetwork.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + ipCidrRange: + description: The range of internal addresses that are owned by this subnetwork. + Provide this property when you create the subnetwork. For example, 10.0.0.0/8 + or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. + Only IPv4 is supported. This field is set at resource creation time. The + range can be any range listed in the Valid ranges list. The range can + be expanded after creation using expandIpCidrRange. + type: string + ipv6AccessType: + description: The access type of IPv6 address this subnet holds. It's immutable + and can only be specified during creation or the first time the subnet + is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then + this subnet cannot enable direct path. + enum: + - EXTERNAL + - UNSPECIFIED_IPV6_ACCESS_TYPE + type: string + ipv6CidrRange: + description: '[Output Only] The range of internal IPv6 addresses that are + owned by this subnetwork.' + type: string + kind: + default: compute#subnetwork + description: '[Output Only] Type of the resource. Always compute#subnetwork + for Subnetwork resources.' + type: string + logConfig: + $ref: '#/components/schemas/SubnetworkLogConfig' + description: This field denotes the VPC flow logging options for this subnetwork. + If logging is enabled, logs are exported to Cloud Logging. + name: + description: The name of the resource, provided by the client when initially + creating the resource. 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 + network: + description: The URL of the network to which this subnetwork belongs, provided + by the client when initially creating the subnetwork. This field can be + set only at resource creation time. + type: string + privateIpGoogleAccess: + description: Whether the VMs in this subnet can access Google services without + assigned external IP addresses. This field can be both set at resource + creation time and updated using setPrivateIpGoogleAccess. + type: boolean + privateIpv6GoogleAccess: + description: The private IPv6 google access type for the VMs in this subnet. + This is an expanded field of enablePrivateV6Access. If both fields are + set, privateIpv6GoogleAccess will take priority. This field can be both + set at resource creation time and updated using patch. + enum: + - DISABLE_GOOGLE_ACCESS + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + type: string + purpose: + description: The purpose of the resource. This field can be either PRIVATE_RFC_1918 + or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER + is a user-created subnetwork that is reserved for Internal HTTP(S) Load + Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The + enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER. + enum: + - INTERNAL_HTTPS_LOAD_BALANCER + - PRIVATE + - PRIVATE_RFC_1918 + - PRIVATE_SERVICE_CONNECT + type: string + region: + description: URL of the region where the Subnetwork resides. This field + can be set only at resource creation time. + type: string + role: + description: The role of subnetwork. Currently, this field is only used + when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE + or BACKUP. An ACTIVE subnetwork is one that is currently being used for + Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready + to be promoted to ACTIVE or is currently draining. This field can be updated + with a patch request. + enum: + - ACTIVE + - BACKUP + type: string + secondaryIpRanges: + description: An array of configurations for secondary IP ranges for VM instances + contained in this subnetwork. The primary IP of such VM must belong to + the primary ipCidrRange of the subnetwork. The alias IPs may belong to + either primary or secondary ranges. This field can be updated with a patch + request. + items: + $ref: '#/components/schemas/SubnetworkSecondaryRange' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + stackType: + description: The stack type for this subnet to identify whether the IPv6 + feature is enabled or not. If not specified IPV4_ONLY will be used. This + field can be both set at resource creation time and updated using patch. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - UNSPECIFIED_STACK_TYPE + type: string + state: + description: '[Output Only] The state of the subnetwork, which can be one + of the following values: READY: Subnetwork is created and ready to use + DRAINING: only applicable to subnetworks that have the purpose set to + INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load + balancer are being drained. A subnetwork that is draining cannot be used + or modified until it reaches a status of READY' + enum: + - DRAINING + - READY + type: string + type: object + SubnetworkAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/SubnetworksScopedList' + description: Name of the scope containing this set of Subnetworks. + description: A list of SubnetworksScopedList resources. + type: object + kind: + default: compute#subnetworkAggregatedList + description: '[Output Only] Type of resource. Always compute#subnetworkAggregatedList + for aggregated lists of subnetworks.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SubnetworkList: + description: Contains a list of Subnetwork resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Subnetwork resources. + items: + $ref: '#/components/schemas/Subnetwork' + type: array + kind: + default: compute#subnetworkList + description: '[Output Only] Type of resource. Always compute#subnetworkList + for lists of subnetworks.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SubnetworkLogConfig: + description: The available logging options for this subnetwork. + properties: + aggregationInterval: + description: Can only be specified if VPC flow logging for this subnetwork + is enabled. Toggles the aggregation interval for collecting flow logs. + Increasing the interval time will reduce the amount of generated flow + logs for long lasting connections. Default is an interval of 5 seconds + per connection. + enum: + - INTERVAL_10_MIN + - INTERVAL_15_MIN + - INTERVAL_1_MIN + - INTERVAL_30_SEC + - INTERVAL_5_MIN + - INTERVAL_5_SEC + type: string + enable: + description: Whether to enable flow logging for this subnetwork. If this + field is not explicitly set, it will not appear in get listings. If not + set the default behavior is to disable flow logging. + type: boolean + filterExpr: + description: Can only be specified if VPC flow logs for this subnetwork + is enabled. Export filter used to define which VPC flow logs should be + logged. + type: string + flowSampling: + description: Can only be specified if VPC flow logging for this subnetwork + is enabled. The value of the field must be in [0, 1]. Set the sampling + rate of VPC flow logs within the subnetwork where 1.0 means all collected + logs are reported and 0.0 means no logs are reported. Default is 0.5, + which means half of all collected logs are reported. + format: float + type: number + metadata: + description: Can only be specified if VPC flow logs for this subnetwork + is enabled. Configures whether all, none or a subset of metadata fields + should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA. + enum: + - CUSTOM_METADATA + - EXCLUDE_ALL_METADATA + - INCLUDE_ALL_METADATA + type: string + metadataFields: + description: Can only be specified if VPC flow logs for this subnetwork + is enabled and "metadata" was set to CUSTOM_METADATA. + items: + type: string + type: array + type: object + SubnetworkSecondaryRange: + description: Represents a secondary IP range of a subnetwork. + properties: + ipCidrRange: + description: The range of IP addresses belonging to this subnetwork secondary + range. Provide this property when you create the subnetwork. Ranges must + be unique and non-overlapping with all primary and secondary IP ranges + within a network. Only IPv4 is supported. The range can be any range listed + in the Valid ranges list. + type: string + rangeName: + description: The name associated with this subnetwork secondary range, used + when adding an alias IP range to a VM instance. The name must be 1-63 + characters long, and comply with RFC1035. The name must be unique within + the subnetwork. + type: string + type: object + SubnetworksExpandIpCidrRangeRequest: + properties: + ipCidrRange: + description: The IP (in CIDR format or netmask) of internal addresses that + are legal on this Subnetwork. This range should be disjoint from other + subnetworks within this network. This range can only be larger than (i.e. + a superset of) the range previously defined before the update. + type: string + type: object + SubnetworksScopedList: + properties: + subnetworks: + description: A list of subnetworks contained in this scope. + items: + $ref: '#/components/schemas/Subnetwork' + type: array + warning: + description: An informational warning that appears when the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SubnetworksSetPrivateIpGoogleAccessRequest: + properties: + privateIpGoogleAccess: + type: boolean + type: object + Subsetting: + description: Subsetting configuration for this BackendService. Currently this + is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load + balancing and Traffic Director. + properties: + policy: + enum: + - CONSISTENT_HASH_SUBSETTING + - NONE + type: string + type: object + TCPHealthCheck: + properties: + port: + description: The TCP port number for the health check request. The default + value is 80. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, TCP health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + request: + description: The application data to send once the TCP connection has been + established (default value is empty). If both request and response are + empty, the connection establishment alone will indicate health. The request + data can only be ASCII. + type: string + response: + description: The bytes to match against the beginning of the response data. + If left empty (the default value), any response will indicate health. + The response data can only be ASCII. + type: string + type: object + Tags: + description: A set of instance tags. + properties: + fingerprint: + description: Specifies a fingerprint for this request, which is essentially + a hash of the tags' contents and used for optimistic locking. The fingerprint + is initially generated by Compute Engine and changes after every request + to modify or update tags. You must always provide an up-to-date fingerprint + hash in order to update or change tags. To see the latest fingerprint, + make get() request to the instance. + format: byte + type: string + items: + description: An array of tags. Each tag must be 1-63 characters long, and + comply with RFC1035. + items: + type: string + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: array + type: object + TargetGrpcProxy: + description: Represents a Target gRPC Proxy resource. A target gRPC proxy is + a component of load balancers intended for load balancing gRPC traffic. Only + global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can + reference a target gRPC proxy. The target gRPC Proxy references a URL map + that specifies how traffic is routed to gRPC backend services. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a TargetGrpcProxy. An up-to-date fingerprint + must be provided in order to patch/update the TargetGrpcProxy; otherwise, + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the TargetGrpcProxy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource type. + The server generates this identifier.' + format: uint64 + type: string + kind: + default: compute#targetGrpcProxy + description: '[Output Only] Type of the resource. Always compute#targetGrpcProxy + for target grpc proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + selfLinkWithId: + description: '[Output Only] Server-defined URL with id for the resource.' + type: string + urlMap: + description: URL to the UrlMap resource that defines the mapping from URL + to the BackendService. The protocol field in the BackendService must be + set to GRPC. + type: string + validateForProxyless: + description: If true, indicates that the BackendServices referenced by the + urlMap may be accessed by gRPC applications without using a sidecar proxy. + This will enable configuration checks on urlMap and its referenced BackendServices + to not allow unsupported features. A gRPC application must use "xds:///" + scheme in the target URI of the service it is connecting to. If false, + indicates that the BackendServices referenced by the urlMap will be accessed + by gRPC applications via a sidecar proxy. In this case, a gRPC application + must not use "xds:///" scheme in the target URI of the service it is connecting + to + type: boolean + type: object + TargetGrpcProxyList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetGrpcProxy resources. + items: + $ref: '#/components/schemas/TargetGrpcProxy' + type: array + kind: + default: compute#targetGrpcProxyList + description: '[Output Only] Type of the resource. Always compute#targetGrpcProxy + for target grpc proxies.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpProxiesScopedList: + properties: + targetHttpProxies: + description: A list of TargetHttpProxies contained in this scope. + items: + $ref: '#/components/schemas/TargetHttpProxy' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpProxy: + description: 'Represents a Target HTTP Proxy resource. Google Compute Engine + has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) + * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target + HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies + are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies + are used by internal HTTP load balancers. Forwarding rules reference a target + HTTP proxy, and the target proxy then references a URL map. For more information, + read Using Target Proxies and Forwarding rule concepts.' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint + must be provided in order to patch/update the TargetHttpProxy; otherwise, + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the TargetHttpProxy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetHttpProxy + description: '[Output Only] Type of resource. Always compute#targetHttpProxy + for target HTTP proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + proxyBind: + description: This field only applies when the forwarding rule that references + this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. + When this field is set to true, Envoy proxies set up inbound traffic interception + and bind to the IP address and port specified in the forwarding rule. + This is generally useful when using Traffic Director to configure Envoy + as a gateway or middle proxy (in other words, not a sidecar proxy). The + Envoy proxy listens for inbound requests and handles requests when it + receives them. The default is false. + type: boolean + region: + description: '[Output Only] URL of the region where the regional Target + HTTP Proxy resides. This field is not applicable to global Target HTTP + Proxies.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + urlMap: + description: URL to the UrlMap resource that defines the mapping from URL + to the BackendService. + type: string + type: object + TargetHttpProxyAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetHttpProxiesScopedList' + description: Name of the scope containing this set of TargetHttpProxies. + description: A list of TargetHttpProxiesScopedList resources. + type: object + kind: + default: compute#targetHttpProxyAggregatedList + description: '[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList + for lists of Target HTTP Proxies.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + type: object + TargetHttpProxyList: + description: A list of TargetHttpProxy resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetHttpProxy resources. + items: + $ref: '#/components/schemas/TargetHttpProxy' + type: array + kind: + default: compute#targetHttpProxyList + description: Type of resource. Always compute#targetHttpProxyList for lists + of target HTTP proxies. + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpsProxiesScopedList: + properties: + targetHttpsProxies: + description: A list of TargetHttpsProxies contained in this scope. + items: + $ref: '#/components/schemas/TargetHttpsProxy' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpsProxiesSetQuicOverrideRequest: + properties: + quicOverride: + description: QUIC policy for the TargetHttpsProxy resource. + enum: + - DISABLE + - ENABLE + - NONE + type: string + type: object + TargetHttpsProxiesSetSslCertificatesRequest: + properties: + sslCertificates: + description: New set of SslCertificate resources to associate with this + TargetHttpsProxy resource. At least one SSL certificate must be specified. + Currently, you may specify up to 15 SSL certificates. + items: + type: string + type: array + type: object + TargetHttpsProxy: + description: 'Represents a Target HTTPS Proxy resource. Google Compute Engine + has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpsProxies) + * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpsProxies) A target + HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies + are used by external HTTPS load balancers. * regionTargetHttpsProxies are + used by internal HTTPS load balancers. Forwarding rules reference a target + HTTPS proxy, and the target proxy then references a URL map. For more information, + read Using Target Proxies and Forwarding rule concepts.' + properties: + authorizationPolicy: + description: 'Optional. A URL referring to a networksecurity.AuthorizationPolicy + resource that describes how the proxy should authorize inbound traffic. + If left blank, access will not be restricted by an authorization policy. + Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy + only applies to a global TargetHttpsProxy attached to globalForwardingRules + with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This + field currently has no impact.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint + must be provided in order to patch the TargetHttpsProxy; otherwise, the + request will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve the TargetHttpsProxy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetHttpsProxy + description: '[Output Only] Type of resource. Always compute#targetHttpsProxy + for target HTTPS proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + proxyBind: + description: This field only applies when the forwarding rule that references + this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. + When this field is set to true, Envoy proxies set up inbound traffic interception + and bind to the IP address and port specified in the forwarding rule. + This is generally useful when using Traffic Director to configure Envoy + as a gateway or middle proxy (in other words, not a sidecar proxy). The + Envoy proxy listens for inbound requests and handles requests when it + receives them. The default is false. + type: boolean + quicOverride: + description: 'Specifies the QUIC override policy for this TargetHttpsProxy + resource. This setting determines whether the load balancer attempts to + negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. + - When quic-override is set to NONE, Google manages whether QUIC is used. + - When quic-override is set to ENABLE, the load balancer uses QUIC when + possible. - When quic-override is set to DISABLE, the load balancer doesn''t + use QUIC. - If the quic-override flag is not specified, NONE is implied. ' + enum: + - DISABLE + - ENABLE + - NONE + type: string + region: + description: '[Output Only] URL of the region where the regional TargetHttpsProxy + resides. This field is not applicable to global TargetHttpsProxies.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + serverTlsPolicy: + description: 'Optional. A URL referring to a networksecurity.ServerTlsPolicy + resource that describes how the proxy should authenticate inbound traffic. + serverTlsPolicy only applies to a global TargetHttpsProxy attached to + globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. + If left blank, communications are not encrypted. Note: This field currently + has no impact.' + type: string + sslCertificates: + description: URLs to SslCertificate resources that are used to authenticate + connections between users and the load balancer. At least one SSL certificate + must be specified. Currently, you may specify up to 15 SSL certificates. + sslCertificates do not apply when the load balancing scheme is set to + INTERNAL_SELF_MANAGED. + items: + type: string + type: array + sslPolicy: + description: URL of SslPolicy resource that will be associated with the + TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has + no SSL policy configured. + type: string + urlMap: + description: 'A fully-qualified or valid partial URL to the UrlMap resource + that defines the mapping from URL to the BackendService. For example, + the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ + url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map ' + type: string + type: object + TargetHttpsProxyAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetHttpsProxiesScopedList' + description: Name of the scope containing this set of TargetHttpsProxies. + description: A list of TargetHttpsProxiesScopedList resources. + type: object + kind: + default: compute#targetHttpsProxyAggregatedList + description: '[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList + for lists of Target HTTP Proxies.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpsProxyList: + description: Contains a list of TargetHttpsProxy resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetHttpsProxy resources. + items: + $ref: '#/components/schemas/TargetHttpsProxy' + type: array + kind: + default: compute#targetHttpsProxyList + description: Type of resource. Always compute#targetHttpsProxyList for lists + of target HTTPS proxies. + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetInstance: + description: Represents a Target Instance resource. You can use a target instance + to handle traffic for one or more forwarding rules, which is ideal for forwarding + protocol traffic that is managed by a single source. For example, ESP, AH, + TCP, or UDP. For more information, read Target instances. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + instance: + description: 'A URL to the virtual machine instance that handles traffic + for this target instance. When creating a target instance, you can provide + the fully-qualified URL or a valid partial URL to the desired virtual + machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /instances/instance - projects/project/zones/zone/instances/instance - + zones/zone/instances/instance ' + type: string + kind: + default: compute#targetInstance + description: '[Output Only] The type of the resource. Always compute#targetInstance + for target instances.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + natPolicy: + description: NAT option controlling how IPs are NAT'ed to the instance. + Currently only NO_NAT (default value) is supported. + enum: + - NO_NAT + type: string + network: + description: The URL of the network this target instance uses to forward + traffic. If not specified, the traffic will be forwarded to the network + that the default network interface belongs to. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + zone: + description: '[Output Only] URL of the zone where the target instance resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + type: object + TargetInstanceAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetInstancesScopedList' + description: Name of the scope containing this set of target instances. + description: A list of TargetInstance resources. + type: object + kind: + default: compute#targetInstanceAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetInstanceList: + description: Contains a list of TargetInstance resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetInstance resources. + items: + $ref: '#/components/schemas/TargetInstance' + type: array + kind: + default: compute#targetInstanceList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetInstancesScopedList: + properties: + targetInstances: + description: A list of target instances contained in this scope. + items: + $ref: '#/components/schemas/TargetInstance' + type: array + warning: + description: Informational warning which replaces the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetPool: + description: Represents a Target Pool resource. Target pools are used for network + TCP/UDP load balancing. A target pool references member instances, an associated + legacy HttpHealthCheck resource, and, optionally, a backup target pool. For + more information, read Using target pools. + properties: + backupPool: + description: 'The server-defined URL for the resource. This field is applicable + only when the containing target pool is serving a forwarding rule as the + primary pool, and its failoverRatio field is properly set to a value between + [0, 1]. backupPool and failoverRatio together define the fallback behavior + of the primary target pool: if the ratio of the healthy instances in the + primary pool is at or below failoverRatio, traffic arriving at the load-balanced + IP will be directed to the backup pool. In case where failoverRatio and + backupPool are not set, or all the instances in the backup pool are unhealthy, + the traffic will be directed back to the primary pool in the "force" mode, + where traffic will be spread to the healthy instances with the best effort, + or to all instances when no instance is healthy.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + failoverRatio: + description: 'This field is applicable only when the containing target pool + is serving a forwarding rule as the primary pool (i.e., not as a backup + pool to some other target pool). The value of the field must be in [0, + 1]. If set, backupPool must also be set. They together define the fallback + behavior of the primary target pool: if the ratio of the healthy instances + in the primary pool is at or below this number, traffic arriving at the + load-balanced IP will be directed to the backup pool. In case where failoverRatio + is not set or all the instances in the backup pool are unhealthy, the + traffic will be directed back to the primary pool in the "force" mode, + where traffic will be spread to the healthy instances with the best effort, + or to all instances when no instance is healthy.' + format: float + type: number + healthChecks: + description: The URL of the HttpHealthCheck resource. A member instance + in this pool is considered healthy if and only if the health checks pass. + Only legacy HttpHealthChecks are supported. Only one health check may + be specified. + items: + type: string + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + instances: + description: A list of resource URLs to the virtual machine instances serving + this pool. They must live in zones contained in the same region as this + pool. + items: + type: string + type: array + kind: + default: compute#targetPool + description: '[Output Only] Type of the resource. Always compute#targetPool + for target pools.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + region: + description: '[Output Only] URL of the region where the target pool resides.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sessionAffinity: + description: 'Session affinity option, must be one of the following values: + NONE: Connections from the same client IP may go to any instance in the + pool. CLIENT_IP: Connections from the same client IP will go to the same + instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: + Connections from the same client IP with the same IP protocol will go + to the same instance in the pool while that instance remains healthy.' + enum: + - CLIENT_IP + - CLIENT_IP_NO_DESTINATION + - CLIENT_IP_PORT_PROTO + - CLIENT_IP_PROTO + - GENERATED_COOKIE + - HEADER_FIELD + - HTTP_COOKIE + - NONE + type: string + type: object + TargetPoolAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetPoolsScopedList' + description: Name of the scope containing this set of target pools. + description: A list of TargetPool resources. + type: object + kind: + default: compute#targetPoolAggregatedList + description: '[Output Only] Type of resource. Always compute#targetPoolAggregatedList + for aggregated lists of target pools.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetPoolInstanceHealth: + properties: + healthStatus: + items: + $ref: '#/components/schemas/HealthStatus' + type: array + kind: + default: compute#targetPoolInstanceHealth + description: '[Output Only] Type of resource. Always compute#targetPoolInstanceHealth + when checking the health of an instance.' + type: string + type: object + TargetPoolList: + description: Contains a list of TargetPool resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetPool resources. + items: + $ref: '#/components/schemas/TargetPool' + type: array + kind: + default: compute#targetPoolList + description: '[Output Only] Type of resource. Always compute#targetPoolList + for lists of target pools.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetPoolsAddHealthCheckRequest: + properties: + healthChecks: + description: The HttpHealthCheck to add to the target pool. + items: + $ref: '#/components/schemas/HealthCheckReference' + type: array + type: object + TargetPoolsAddInstanceRequest: + properties: + instances: + description: 'A full or partial URL to an instance to add to this target + pool. This can be a full or partial URL. For example, the following are + valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone + /instances/instance-name - projects/project-id/zones/zone/instances/instance-name + - zones/zone/instances/instance-name ' + items: + $ref: '#/components/schemas/InstanceReference' + type: array + type: object + TargetPoolsRemoveHealthCheckRequest: + properties: + healthChecks: + description: 'Health check URL to be removed. This can be a full or valid + partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project + /global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check + - global/httpHealthChecks/health-check ' + items: + $ref: '#/components/schemas/HealthCheckReference' + type: array + type: object + TargetPoolsRemoveInstanceRequest: + properties: + instances: + description: URLs of the instances to be removed from target pool. + items: + $ref: '#/components/schemas/InstanceReference' + type: array + type: object + TargetPoolsScopedList: + properties: + targetPools: + description: A list of target pools contained in this scope. + items: + $ref: '#/components/schemas/TargetPool' + type: array + warning: + description: Informational warning which replaces the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetReference: + properties: + target: + type: string + type: object + TargetSslProxiesSetBackendServiceRequest: + properties: + service: + description: The URL of the new BackendService resource for the targetSslProxy. + type: string + type: object + TargetSslProxiesSetProxyHeaderRequest: + properties: + proxyHeader: + description: The new type of proxy header to append before sending data + to the backend. NONE or PROXY_V1 are allowed. + enum: + - NONE + - PROXY_V1 + type: string + type: object + TargetSslProxiesSetSslCertificatesRequest: + properties: + sslCertificates: + description: New set of URLs to SslCertificate resources to associate with + this TargetSslProxy. At least one SSL certificate must be specified. Currently, + you may specify up to 15 SSL certificates. + items: + type: string + type: array + type: object + TargetSslProxy: + description: Represents a Target SSL Proxy resource. A target SSL proxy is a + component of a SSL Proxy load balancer. Global forwarding rules reference + a target SSL proxy, and the target proxy then references an external backend + service. For more information, read Using Target Proxies. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetSslProxy + description: '[Output Only] Type of the resource. Always compute#targetSslProxy + for target SSL proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + service: + description: URL to the BackendService resource. + type: string + sslCertificates: + description: URLs to SslCertificate resources that are used to authenticate + connections to Backends. At least one SSL certificate must be specified. + Currently, you may specify up to 15 SSL certificates. sslCertificates + do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + items: + type: string + type: array + sslPolicy: + description: URL of SslPolicy resource that will be associated with the + TargetSslProxy resource. If not set, the TargetSslProxy resource will + not have any SSL policy configured. + type: string + type: object + TargetSslProxyList: + description: Contains a list of TargetSslProxy resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetSslProxy resources. + items: + $ref: '#/components/schemas/TargetSslProxy' + type: array + kind: + default: compute#targetSslProxyList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetTcpProxiesSetBackendServiceRequest: + properties: + service: + description: The URL of the new BackendService resource for the targetTcpProxy. + type: string + type: object + TargetTcpProxiesSetProxyHeaderRequest: + properties: + proxyHeader: + description: The new type of proxy header to append before sending data + to the backend. NONE or PROXY_V1 are allowed. + enum: + - NONE + - PROXY_V1 + type: string + type: object + TargetTcpProxy: + description: Represents a Target TCP Proxy resource. A target TCP proxy is a + component of a TCP Proxy load balancer. Global forwarding rules reference + target TCP proxy, and the target proxy then references an external backend + service. For more information, read TCP Proxy Load Balancing overview. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetTcpProxy + description: '[Output Only] Type of the resource. Always compute#targetTcpProxy + for target TCP proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + proxyBind: + description: This field only applies when the forwarding rule that references + this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. + When this field is set to true, Envoy proxies set up inbound traffic interception + and bind to the IP address and port specified in the forwarding rule. + This is generally useful when using Traffic Director to configure Envoy + as a gateway or middle proxy (in other words, not a sidecar proxy). The + Envoy proxy listens for inbound requests and handles requests when it + receives them. The default is false. + type: boolean + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + service: + description: URL to the BackendService resource. + type: string + type: object + TargetTcpProxyList: + description: Contains a list of TargetTcpProxy resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetTcpProxy resources. + items: + $ref: '#/components/schemas/TargetTcpProxy' + type: array + kind: + default: compute#targetTcpProxyList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetVpnGateway: + description: Represents a Target VPN Gateway resource. The target VPN gateway + resource represents a Classic Cloud VPN gateway. For more information, read + the the Cloud VPN Overview. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + forwardingRules: + description: '[Output Only] A list of URLs to the ForwardingRule resources. + ForwardingRules are created using compute.forwardingRules.insert and associated + with a VPN gateway.' + items: + type: string + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetVpnGateway + description: '[Output Only] Type of resource. Always compute#targetVpnGateway + for target VPN gateways.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: URL of the network to which this VPN gateway is attached. Provided + by the client when the VPN gateway is created. + type: string + region: + description: '[Output Only] URL of the region where the target VPN gateway + resides. You must specify this field as part of the HTTP request URL. + It is not settable as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of the VPN gateway, which can be + one of the following: CREATING, READY, FAILED, or DELETING.' + enum: + - CREATING + - DELETING + - FAILED + - READY + type: string + tunnels: + description: '[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels + are created using the compute.vpntunnels.insert method and associated + with a VPN gateway.' + items: + type: string + type: array + type: object + TargetVpnGatewayAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetVpnGatewaysScopedList' + description: '[Output Only] Name of the scope containing this set of target + VPN gateways.' + description: A list of TargetVpnGateway resources. + type: object + kind: + default: compute#targetVpnGatewayAggregatedList + description: '[Output Only] Type of resource. Always compute#targetVpnGateway + for target VPN gateways.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetVpnGatewayList: + description: Contains a list of TargetVpnGateway resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetVpnGateway resources. + items: + $ref: '#/components/schemas/TargetVpnGateway' + type: array + kind: + default: compute#targetVpnGatewayList + description: '[Output Only] Type of resource. Always compute#targetVpnGateway + for target VPN gateways.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetVpnGatewaysScopedList: + properties: + targetVpnGateways: + description: '[Output Only] A list of target VPN gateways contained in this + scope.' + items: + $ref: '#/components/schemas/TargetVpnGateway' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of addresses 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TestFailure: + properties: + actualOutputUrl: + description: The actual output URL evaluated by load balancer containing + the scheme, host, path and query parameters. + type: string + actualRedirectResponseCode: + description: Actual HTTP status code for rule with `urlRedirect` calculated + by load balancer + format: int32 + type: integer + actualService: + description: BackendService or BackendBucket returned by load balancer. + type: string + expectedOutputUrl: + description: The expected output URL evaluated by load balancer containing + the scheme, host, path and query parameters. + type: string + expectedRedirectResponseCode: + description: Expected HTTP status code for rule with `urlRedirect` calculated + by load balancer + format: int32 + type: integer + expectedService: + description: Expected BackendService or BackendBucket resource the given + URL should be mapped to. + type: string + headers: + description: HTTP headers of the request. + items: + $ref: '#/components/schemas/UrlMapTestHeader' + type: array + host: + description: Host portion of the URL. + type: string + path: + description: Path portion including query parameters in the URL. + type: string + type: object + TestPermissionsRequest: + properties: + permissions: + description: The set of permissions to check for the 'resource'. Permissions + with wildcards (such as '*' or 'storage.*') are not allowed. + items: + type: string + type: array + type: object + TestPermissionsResponse: + properties: + permissions: + description: A subset of `TestPermissionsRequest.permissions` that the caller + is allowed. + items: + type: string + type: array + type: object + Uint128: + properties: + high: + format: uint64 + type: string + low: + format: uint64 + type: string + type: object + UrlMap: + description: 'Represents a URL Map resource. Google Compute Engine has two URL + Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) + A URL map resource is a component of certain types of GCP load balancers and + Traffic Director. * urlMaps are used by external HTTP(S) load balancers and + Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. + For a list of supported URL map features by load balancer type, see the Load + balancing features: Routing and traffic management table. For a list of supported + URL map features for Traffic Director, see the Traffic Director features: + Routing and traffic management table. This resource defines mappings from + host names and URL paths to either a backend service or a backend bucket. + To use the global urlMaps resource, the backend service must have a loadBalancingScheme + of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, + the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For + more information, read URL Map Concepts.' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + defaultRouteAction: + $ref: '#/components/schemas/HttpRouteAction' + description: defaultRouteAction takes effect when none of the hostRules + match. The load balancer performs advanced routing actions like URL rewrites, + header transformations, etc. prior to forwarding the request to the selected + backend. If defaultRouteAction specifies any weightedBackendServices, + defaultService must not be set. Conversely if defaultService is set, defaultRouteAction + cannot contain any weightedBackendServices. Only one of defaultRouteAction + or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers + support only the urlRewrite action within defaultRouteAction. defaultRouteAction + has no effect when the URL map is bound to target gRPC proxy that has + validateForProxyless field set to true. + defaultService: + description: The full or partial URL of the defaultService resource to which + traffic is directed if none of the hostRules match. If defaultRouteAction + is additionally specified, advanced routing actions like URL Rewrites, + etc. take effect prior to sending the request to the backend. However, + if defaultService is specified, defaultRouteAction cannot contain any + weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, + service must not be specified. Only one of defaultService, defaultUrlRedirect + or defaultRouteAction.weightedBackendService must be set. defaultService + has no effect when the URL map is bound to target gRPC proxy that has + validateForProxyless field set to true. + type: string + defaultUrlRedirect: + $ref: '#/components/schemas/HttpRedirectAction' + description: When none of the specified hostRules match, the request is + redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect + is specified, defaultService or defaultRouteAction must not be set. Not + supported when the URL map is bound to target gRPC proxy. + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a UrlMap. An up-to-date fingerprint must be + provided in order to update the UrlMap, otherwise the request will fail + with error 412 conditionNotMet. To see the latest fingerprint, make a + get() request to retrieve a UrlMap. + format: byte + type: string + headerAction: + $ref: '#/components/schemas/HttpHeaderAction' + description: Specifies changes to request and response headers that need + to take effect for the selected backendService. The headerAction specified + here take effect after headerAction specified under pathMatcher. Note + that headerAction is not supported for Loadbalancers that have their loadBalancingScheme + set to EXTERNAL. Not supported when the URL map is bound to target gRPC + proxy that has validateForProxyless field set to true. + hostRules: + description: The list of HostRules to use against the URL. + items: + $ref: '#/components/schemas/HostRule' + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#urlMap + description: '[Output Only] Type of the resource. Always compute#urlMaps + for url maps.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + pathMatchers: + description: The list of named PathMatchers to use against the URL. + items: + $ref: '#/components/schemas/PathMatcher' + type: array + region: + description: '[Output Only] URL of the region where the regional URL map + resides. This field is not applicable to global URL maps. You must specify + this field as part of the HTTP request URL. It is not settable as a field + in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + tests: + description: The list of expected URL mapping tests. Request to update this + UrlMap will succeed only if all of the test cases pass. You can specify + a maximum of 100 tests per UrlMap. Not supported when the URL map is bound + to target gRPC proxy that has validateForProxyless field set to true. + items: + $ref: '#/components/schemas/UrlMapTest' + type: array + type: object + UrlMapList: + description: Contains a list of UrlMap resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of UrlMap resources. + items: + $ref: '#/components/schemas/UrlMap' + type: array + kind: + default: compute#urlMapList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + UrlMapReference: + properties: + urlMap: + type: string + type: object + UrlMapTest: + description: Message for the expected URL mappings. + properties: + description: + description: Description of this test case. + type: string + expectedOutputUrl: + description: The expected output URL evaluated by load balancer containing + the scheme, host, path and query parameters. For rules that forward requests + to backends, the test passes only when expectedOutputUrl matches the request + forwarded by load balancer to backends. For rules with urlRewrite, the + test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite + in the urlRewrite action. When service is specified, expectedOutputUrl`s + scheme is ignored. For rules with urlRedirect, the test passes only if + expectedOutputUrl matches the URL in the load balancer's redirect response. + If urlRedirect specifies https_redirect, the test passes only if the scheme + in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, + the test passes only if expectedOutputUrl does not contain any query parameters. + expectedOutputUrl is optional when service is specified. + type: string + expectedRedirectResponseCode: + description: For rules with urlRedirect, the test passes only if expectedRedirectResponseCode + matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode + cannot be set when service is set. + format: int32 + type: integer + headers: + description: HTTP headers for this request. If headers contains a host header, + then host must also match the header value. + items: + $ref: '#/components/schemas/UrlMapTestHeader' + type: array + host: + description: Host portion of the URL. If headers contains a host header, + then host must also match the header value. + type: string + path: + description: Path portion of the URL. + type: string + service: + description: Expected BackendService or BackendBucket resource the given + URL should be mapped to. service cannot be set if expectedRedirectResponseCode + is set. + type: string + type: object + UrlMapTestHeader: + description: HTTP headers used in UrlMapTests. + properties: + name: + description: Header name. + type: string + value: + description: Header value. + type: string + type: object + UrlMapValidationResult: + description: Message representing the validation result for a UrlMap. + properties: + loadErrors: + items: + type: string + type: array + loadSucceeded: + description: Whether the given UrlMap can be successfully loaded. If false, + 'loadErrors' indicates the reasons. + type: boolean + testFailures: + items: + $ref: '#/components/schemas/TestFailure' + type: array + testPassed: + description: If successfully loaded, this field indicates whether the test + passed. If false, 'testFailures's indicate the reason of failure. + type: boolean + type: object + UrlMapsAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/UrlMapsScopedList' + description: Name of the scope containing this set of UrlMaps. + description: A list of UrlMapsScopedList resources. + type: object + kind: + default: compute#urlMapsAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + UrlMapsScopedList: + properties: + urlMaps: + description: A list of UrlMaps contained in this scope. + items: + $ref: '#/components/schemas/UrlMap' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + UrlMapsValidateRequest: + properties: + resource: + $ref: '#/components/schemas/UrlMap' + description: Content of the UrlMap to be validated. + type: object + UrlMapsValidateResponse: + properties: + result: + $ref: '#/components/schemas/UrlMapValidationResult' + type: object + UrlRewrite: + description: The spec for modifying the path before sending the request to the + matched backend service. + properties: + hostRewrite: + description: Prior to forwarding the request to the selected service, the + request's host header is replaced with contents of hostRewrite. The value + must be between 1 and 255 characters. + type: string + pathPrefixRewrite: + description: Prior to forwarding the request to the selected backend service, + the matching portion of the request's path is replaced by pathPrefixRewrite. + The value must be between 1 and 1024 characters. + type: string + type: object + UsableSubnetwork: + description: Subnetwork which the current user has compute.subnetworks.use permission + on. + properties: + ipCidrRange: + description: The range of internal addresses that are owned by this subnetwork. + type: string + network: + description: Network URL. + type: string + secondaryIpRanges: + description: Secondary IP ranges. + items: + $ref: '#/components/schemas/UsableSubnetworkSecondaryRange' + type: array + subnetwork: + description: Subnetwork URL. + type: string + type: object + UsableSubnetworkSecondaryRange: + description: Secondary IP range of a usable subnetwork. + properties: + ipCidrRange: + description: The range of IP addresses belonging to this subnetwork secondary + range. + type: string + rangeName: + description: The name associated with this subnetwork secondary range, used + when adding an alias IP range to a VM instance. The name must be 1-63 + characters long, and comply with RFC1035. The name must be unique within + the subnetwork. + type: string + type: object + UsableSubnetworksAggregatedList: + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + description: '[Output] A list of usable subnetwork URLs.' + items: + $ref: '#/components/schemas/UsableSubnetwork' + type: array + kind: + default: compute#usableSubnetworksAggregatedList + description: '[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList + for aggregated lists of usable subnetworks.' + 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. In special cases listUsable may + return 0 subnetworks and nextPageToken which still should be used to get + the next page of 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + UsageExportLocation: + description: The location in Cloud Storage and naming method of the daily usage + report. Contains bucket_name and report_name prefix. + properties: + bucketName: + description: The name of an existing bucket in Cloud Storage where the usage + report object is stored. The Google Service Account is granted write access + to this bucket. This can either be the bucket name by itself, such as + example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ + in front of it, such as gs://example-bucket. + type: string + reportNamePrefix: + description: An optional prefix for the name of the usage report object + stored in bucketName. If not supplied, defaults to usage_gce. The report + is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where + YYYYMMDD is the day of the usage according to Pacific Time. If you supply + a prefix, it should conform to Cloud Storage object naming conventions. + type: string + type: object + VmEndpointNatMappings: + description: Contain information of Nat mapping for a VM endpoint (i.e., NIC). + properties: + instanceName: + description: Name of the VM instance which the endpoint belongs to + type: string + interfaceNatMappings: + items: + $ref: '#/components/schemas/VmEndpointNatMappingsInterfaceNatMappings' + type: array + type: object + VmEndpointNatMappingsInterfaceNatMappings: + description: Contain information of Nat mapping for an interface of this endpoint. + properties: + drainNatIpPortRanges: + description: 'List of all drain IP:port-range mappings assigned to this + interface. These ranges are inclusive, that is, both the first and the + last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].' + items: + type: string + type: array + natIpPortRanges: + description: 'A list of all IP:port-range mappings assigned to this interface. + These ranges are inclusive, that is, both the first and the last ports + can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].' + items: + type: string + type: array + numTotalDrainNatPorts: + description: Total number of drain ports across all NAT IPs allocated to + this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges. + format: int32 + type: integer + numTotalNatPorts: + description: Total number of ports across all NAT IPs allocated to this + interface. It equals to the aggregated port number in the field nat_ip_port_ranges. + format: int32 + type: integer + sourceAliasIpRange: + description: 'Alias IP range for this interface endpoint. It will be a private + (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24".' + type: string + sourceVirtualIp: + description: Primary IP of the VM for this NIC. + type: string + type: object + VmEndpointNatMappingsList: + description: Contains a list of VmEndpointNatMappings. + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + kind: + default: compute#vmEndpointNatMappingsList + description: '[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList + for lists of Nat mappings of VM endpoints.' + 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 + result: + description: '[Output Only] A list of Nat mapping information of VM endpoints.' + items: + $ref: '#/components/schemas/VmEndpointNatMappings' + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnGateway: + description: Represents a HA VPN gateway. HA VPN is a high-availability (HA) + Cloud VPN solution that lets you securely connect your on-premises network + to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection + in a single region. For more information about Cloud HA VPN solutions, see + Cloud VPN topologies . + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#vpnGateway + description: '[Output Only] Type of resource. Always compute#vpnGateway + for VPN gateways.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this VpnGateway, + which is essentially a hash of the labels set used for optimistic locking. + The fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve an VpnGateway. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels for this resource. These can only be added or modified + by the setLabels method. Each label key/value pair must comply with RFC1035. + Label values may be empty. + type: object + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: URL of the network to which this VPN gateway is attached. Provided + by the client when the VPN gateway is created. + type: string + region: + description: '[Output Only] URL of the region where the VPN gateway resides.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + vpnInterfaces: + description: The list of VPN interfaces associated with this VPN gateway. + items: + $ref: '#/components/schemas/VpnGatewayVpnGatewayInterface' + type: array + type: object + VpnGatewayAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/VpnGatewaysScopedList' + description: '[Output Only] Name of the scope containing this set of VPN + gateways.' + description: A list of VpnGateway resources. + type: object + kind: + default: compute#vpnGatewayAggregatedList + description: '[Output Only] Type of resource. Always compute#vpnGateway + for VPN gateways.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnGatewayList: + description: Contains a list of VpnGateway resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of VpnGateway resources. + items: + $ref: '#/components/schemas/VpnGateway' + type: array + kind: + default: compute#vpnGatewayList + description: '[Output Only] Type of resource. Always compute#vpnGateway + for VPN gateways.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnGatewayStatus: + properties: + vpnConnections: + description: List of VPN connection for this VpnGateway. + items: + $ref: '#/components/schemas/VpnGatewayStatusVpnConnection' + type: array + type: object + VpnGatewayStatusHighAvailabilityRequirementState: + description: Describes the high availability requirement state for the VPN connection + between this Cloud VPN gateway and a peer gateway. + properties: + state: + description: Indicates the high availability requirement state for the VPN + connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. + enum: + - CONNECTION_REDUNDANCY_MET + - CONNECTION_REDUNDANCY_NOT_MET + type: string + unsatisfiedReason: + description: Indicates the reason why the VPN connection does not meet the + high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. + enum: + - INCOMPLETE_TUNNELS_COVERAGE + type: string + type: object + VpnGatewayStatusTunnel: + description: Contains some information about a VPN tunnel. + properties: + localGatewayInterface: + description: The VPN gateway interface this VPN tunnel is associated with. + format: uint32 + type: integer + peerGatewayInterface: + description: The peer gateway interface this VPN tunnel is connected to, + the peer gateway could either be an external VPN gateway or GCP VPN gateway. + format: uint32 + type: integer + tunnelUrl: + description: URL reference to the VPN tunnel. + type: string + type: object + VpnGatewayStatusVpnConnection: + description: A VPN connection contains all VPN tunnels connected from this VpnGateway + to the same peer gateway. The peer gateway could either be a external VPN + gateway or GCP VPN gateway. + properties: + peerExternalGateway: + description: URL reference to the peer external VPN gateways to which the + VPN tunnels in this VPN connection are connected. This field is mutually + exclusive with peer_gcp_gateway. + type: string + peerGcpGateway: + description: URL reference to the peer side VPN gateways to which the VPN + tunnels in this VPN connection are connected. This field is mutually exclusive + with peer_gcp_gateway. + type: string + state: + $ref: '#/components/schemas/VpnGatewayStatusHighAvailabilityRequirementState' + description: HighAvailabilityRequirementState for the VPN connection. + tunnels: + description: List of VPN tunnels that are in this VPN connection. + items: + $ref: '#/components/schemas/VpnGatewayStatusTunnel' + type: array + type: object + VpnGatewayVpnGatewayInterface: + description: A VPN gateway interface. + properties: + id: + description: '[Output Only] Numeric identifier for this VPN interface associated + with the VPN gateway.' + format: uint32 + type: integer + interconnectAttachment: + description: 'URL of the VLAN attachment (interconnectAttachment) resource + for this VPN gateway interface. When the value of this field is present, + the VPN gateway is used for IPsec-encrypted Cloud Interconnect; all egress + or ingress traffic for this VPN gateway interface goes through the specified + VLAN attachment resource. Not currently available publicly. ' + type: string + ipAddress: + description: '[Output Only] IP address for this VPN interface associated + with the VPN gateway. The IP address could be either a regional external + IP address or a regional internal IP address. The two IP addresses for + a VPN gateway must be all regional external or regional internal IP addresses. + There cannot be a mix of regional external IP addresses and regional internal + IP addresses. For IPsec-encrypted Cloud Interconnect, the IP addresses + for both interfaces could either be regional internal IP addresses or + regional external IP addresses. For regular (non IPsec-encrypted Cloud + Interconnect) HA VPN tunnels, the IP address must be a regional external + IP address.' + type: string + type: object + VpnGatewaysGetStatusResponse: + properties: + result: + $ref: '#/components/schemas/VpnGatewayStatus' + type: object + VpnGatewaysScopedList: + properties: + vpnGateways: + description: '[Output Only] A list of VPN gateways contained in this scope.' + items: + $ref: '#/components/schemas/VpnGateway' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of addresses 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnTunnel: + description: Represents a Cloud VPN Tunnel resource. For more information about + VPN, read the the Cloud VPN Overview. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + detailedStatus: + description: '[Output Only] Detailed status message for the VPN tunnel.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + ikeVersion: + description: IKE protocol version to use when establishing the VPN tunnel + with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default + version is 2. + format: int32 + type: integer + kind: + default: compute#vpnTunnel + description: '[Output Only] Type of resource. Always compute#vpnTunnel for + VPN tunnels.' + type: string + localTrafficSelector: + description: 'Local traffic selector to use when establishing the VPN tunnel + with the peer VPN gateway. The value should be a CIDR formatted string, + for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is + supported.' + items: + type: string + type: array + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + peerExternalGateway: + description: URL of the peer side external VPN gateway to which this VPN + tunnel is connected. Provided by the client when the VPN tunnel is created. + This field is exclusive with the field peerGcpGateway. + type: string + peerExternalGatewayInterface: + description: The interface ID of the external VPN gateway to which this + VPN tunnel is connected. Provided by the client when the VPN tunnel is + created. + format: int32 + type: integer + peerGcpGateway: + description: URL of the peer side HA GCP VPN gateway to which this VPN tunnel + is connected. Provided by the client when the VPN tunnel is created. This + field can be used when creating highly available VPN from VPC network + to VPC network, the field is exclusive with the field peerExternalGateway. + If provided, the VPN tunnel will automatically use the same vpnGatewayInterface + ID in the peer GCP VPN gateway. + type: string + peerIp: + description: IP address of the peer VPN gateway. Only IPv4 is supported. + type: string + region: + description: '[Output Only] URL of the region where the VPN tunnel resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + remoteTrafficSelector: + description: 'Remote traffic selectors to use when establishing the VPN + tunnel with the peer VPN gateway. The value should be a CIDR formatted + string, for example: 192.168.0.0/16. The ranges should be disjoint. Only + IPv4 is supported.' + items: + type: string + type: array + router: + description: URL of the router resource to be used for dynamic routing. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sharedSecret: + description: Shared secret used to set the secure session between the Cloud + VPN gateway and the peer VPN gateway. + type: string + sharedSecretHash: + description: Hash of the shared secret. + type: string + status: + description: '[Output Only] The status of the VPN tunnel, which can be one + of the following: - PROVISIONING: Resource is being allocated for the + VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related + configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, + and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: + Successful first handshake with the peer VPN. - ESTABLISHED: Secure session + is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, + replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for + example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. + - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. + - FAILED: Tunnel creation has failed and the tunnel is not ready to be + used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: + Tunnel configuration was rejected, can be result of being denied access. + - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all + required resources. - STOPPED: Tunnel is stopped due to its Forwarding + Rules being deleted for Classic VPN tunnels or the project is in frozen + state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, + probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing + not allowed for an HA-VPN tunnel. ' + enum: + - ALLOCATING_RESOURCES + - AUTHORIZATION_ERROR + - DEPROVISIONING + - ESTABLISHED + - FAILED + - FIRST_HANDSHAKE + - NEGOTIATION_FAILURE + - NETWORK_ERROR + - NO_INCOMING_PACKETS + - PROVISIONING + - REJECTED + - STOPPED + - WAITING_FOR_FULL_CONFIG + type: string + targetVpnGateway: + description: URL of the Target VPN gateway with which this VPN tunnel is + associated. Provided by the client when the VPN tunnel is created. + type: string + vpnGateway: + description: URL of the VPN gateway with which this VPN tunnel is associated. + Provided by the client when the VPN tunnel is created. This must be used + (instead of target_vpn_gateway) if a High Availability VPN gateway resource + is created. + type: string + vpnGatewayInterface: + description: The interface ID of the VPN gateway with which this VPN tunnel + is associated. + format: int32 + type: integer + type: object + VpnTunnelAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/VpnTunnelsScopedList' + description: Name of the scope containing this set of VPN tunnels. + description: A list of VpnTunnelsScopedList resources. + type: object + kind: + default: compute#vpnTunnelAggregatedList + description: '[Output Only] Type of resource. Always compute#vpnTunnel for + VPN tunnels.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnTunnelList: + description: Contains a list of VpnTunnel resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of VpnTunnel resources. + items: + $ref: '#/components/schemas/VpnTunnel' + type: array + kind: + default: compute#vpnTunnelList + description: '[Output Only] Type of resource. Always compute#vpnTunnel for + VPN tunnels.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnTunnelsScopedList: + properties: + vpnTunnels: + description: A list of VPN tunnels contained in this scope. + items: + $ref: '#/components/schemas/VpnTunnel' + type: array + warning: + description: Informational warning which replaces the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + WafExpressionSet: + properties: + aliases: + description: 'A list of alternate IDs. The format should be: - E.g. XSS-stable + Generic suffix like "stable" is particularly useful if a policy likes + to avail newer set of expressions without having to change the policy. + A given alias name can''t be used for more than one entity set.' + items: + type: string + type: array + expressions: + description: List of available expressions. + items: + $ref: '#/components/schemas/WafExpressionSetExpression' + type: array + id: + description: 'Google specified expression set ID. The format should be: + - E.g. XSS-20170329 required' + type: string + type: object + WafExpressionSetExpression: + properties: + id: + description: Expression ID should uniquely identify the origin of the expression. + E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version + 2.9.1 rule id 973337. The ID could be used to determine the individual + attack definition that has been detected. It could also be used to exclude + it from the policy in case of false positive. required + type: string + type: object + WeightedBackendService: + description: In contrast to a single BackendService in HttpRouteAction to which + all matching traffic is directed to, WeightedBackendService allows traffic + to be split across multiple BackendServices. The volume of traffic for each + BackendService is proportional to the weight specified in each WeightedBackendService + properties: + backendService: + description: The full or partial URL to the default BackendService resource. + Before forwarding the request to backendService, the loadbalancer applies + any relevant headerActions specified as part of this backendServiceWeight. + type: string + headerAction: + $ref: '#/components/schemas/HttpHeaderAction' + description: Specifies changes to request and response headers that need + to take effect for the selected backendService. headerAction specified + here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher + and UrlMap. Note that headerAction is not supported for Loadbalancers + that have their loadBalancingScheme set to EXTERNAL. Not supported when + the URL map is bound to target gRPC proxy that has validateForProxyless + field set to true. + weight: + description: Specifies the fraction of traffic sent to backendService, computed + as weight / (sum of all weightedBackendService weights in routeAction) + . The selection of a backend service is determined only for new traffic. + Once a user's request has been directed to a backendService, subsequent + requests will be sent to the same backendService as determined by the + BackendService's session affinity policy. The value must be between 0 + and 1000 + format: uint32 + type: integer + type: object + XpnHostList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: '[Output Only] A list of shared VPC host project URLs.' + items: + $ref: '#/components/schemas/Project' + type: array + kind: + default: compute#xpnHostList + description: '[Output Only] Type of resource. Always compute#xpnHostList + for lists of shared VPC hosts.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + XpnResourceId: + description: Service resource (a.k.a service project) ID. + properties: + id: + description: The ID of the service resource. In the case of projects, this + field supports project id (e.g., my-project-123) and project number (e.g. + 12345678). + type: string + type: + description: The type of the service resource. + enum: + - PROJECT + - XPN_RESOURCE_TYPE_UNSPECIFIED + type: string + type: object + Zone: + description: Represents a Zone resource. A zone is a deployment area. These + deployment areas are subsets of a region. For example the zone us-east1-a + is located in the us-east1 region. For more information, read Regions and + Zones. + properties: + availableCpuPlatforms: + description: '[Output Only] Available cpu/platform selections for the zone.' + items: + type: string + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + zone.' + description: + description: '[Output Only] Textual description of the resource.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#zone + description: '[Output Only] Type of the resource. Always compute#zone for + zones.' + type: string + name: + description: '[Output Only] Name of the resource.' + type: string + region: + description: '[Output Only] Full URL reference to the region which hosts + the zone.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] Status of the zone, either UP or DOWN.' + enum: + - DOWN + - UP + type: string + supportsPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + type: object + ZoneList: + description: Contains a list of zone resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Zone resources. + items: + $ref: '#/components/schemas/Zone' + type: array + kind: + default: compute#zoneList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ZoneSetLabelsRequest: + properties: + labelFingerprint: + description: The fingerprint of the previous set of labels for this resource, + used to detect conflicts. The fingerprint is initially generated by Compute + Engine and changes after every request to modify or update labels. You + must always provide an up-to-date fingerprint hash in order to update + or change labels. Make a get() request to the resource to get the latest + fingerprint. + format: byte + type: string + labels: + additionalProperties: + type: string + description: The labels to set for this resource. + type: object + type: object + ZoneSetPolicyRequest: + properties: + bindings: + description: Flatten Policy to create a backwacd compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + format: byte + type: string + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the ''resource''. + The size of the policy is limited to a few 10s of KB. An empty policy + is in general a valid policy but certain services (like Projects) might + reject them.' + type: object + securitySchemes: + Oauth2: + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + https://www.googleapis.com/auth/compute: View and manage your Google Compute + Engine resources + https://www.googleapis.com/auth/compute.readonly: View your Google Compute + Engine resources + https://www.googleapis.com/auth/devstorage.full_control: Manage your data + and permissions in Cloud Storage and see the email address for your + Google Account + https://www.googleapis.com/auth/devstorage.read_only: View your data in + Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_write: Manage your data + in Cloud Storage and see the email address of your Google Account + type: oauth2 + Oauth2c: + description: Oauth 2.0 authorizationCode authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + https://www.googleapis.com/auth/compute: View and manage your Google Compute + Engine resources + https://www.googleapis.com/auth/compute.readonly: View your Google Compute + Engine resources + https://www.googleapis.com/auth/devstorage.full_control: Manage your data + and permissions in Cloud Storage and see the email address for your + Google Account + https://www.googleapis.com/auth/devstorage.read_only: View your data in + Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_write: Manage your data + in Cloud Storage and see the email address of your Google Account + tokenUrl: https://accounts.google.com/o/oauth2/token + type: oauth2 +externalDocs: + url: https://cloud.google.com/compute/ +info: + contact: + name: Google + url: https://google.com + x-twitter: youtube + description: 'Creates and runs virtual machines on Google Cloud Platform. ' + license: + name: Creative Commons Attribution 3.0 + url: http://creativecommons.org/licenses/by/3.0/ + termsOfService: https://developers.google.com/terms/ + title: Compute Engine API + version: v1 + x-apiClientRegistration: + url: https://console.developers.google.com + x-apisguru-categories: + - analytics + - media + x-logo: + url: https://api.apis.guru/v2/cache/logo/https_www.google.com_images_branding_googlelogo_2x_googlelogo_color_272x92dp.png + x-origin: + - converter: + url: https://github.com/mermade/oas-kit + version: 7.0.4 + format: google + url: https://www.googleapis.com/discovery/v1/apis/compute/v1/rest + version: v1 + x-preferred: true + x-providerName: googleapis.com + x-serviceName: compute +openapi: 3.0.0 +paths: + /projects/{project}/aggregated/disks: + get: + description: Retrieves an aggregated list of persistent disks. + operationId: compute.disks.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/disks: + get: + description: Retrieves a list of persistent disks contained within the specified + zone. + operationId: compute.disks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a persistent disk in the specified project using the data + in the request. You can create a disk from a source (sourceImage, sourceSnapshot, + or sourceDisk) or create an empty 500 GB data disk by omitting all properties. + You can also create a disk that is larger than the default size by specifying + the sizeGb property. + operationId: compute.disks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + - description: Source image to restore onto a disk. This field is optional. + in: query + name: sourceImage + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{disk}: + delete: + description: Deletes the specified persistent disk. Deleting a disk removes + its data permanently and is irreversible. However, deleting a disk does not + delete any snapshots previously made from the disk. You must separately delete + snapshots. + operationId: compute.disks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the persistent disk to delete. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + get: + description: Returns a specified persistent disk. Gets a list of available persistent + disks by making a list() request. + operationId: compute.disks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the persistent disk to return. + in: path + name: disk + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds existing resource policies to a disk. You can only add one + policy which will be applied to this disk for scheduling snapshot creation. + operationId: compute.disks.addResourcePolicies + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The disk name for this request. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksAddResourcePoliciesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{disk}/createSnapshot: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a snapshot of a specified persistent disk. + operationId: compute.disks.createSnapshot + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the persistent disk to snapshot. + in: path + name: disk + required: true + schema: + type: string + - description: '[Input Only] Whether to attempt an application consistent snapshot + by informing the OS to prepare for the snapshot process. Currently only + supported on Windows instances using the Volume Shadow Copy Service (VSS).' + in: query + name: guestFlush + schema: + type: boolean + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes resource policies from a disk. + operationId: compute.disks.removeResourcePolicies + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The disk name for this request. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksRemoveResourcePoliciesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{disk}/resize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Resizes the specified persistent disk. You can only increase the + size of the disk. + operationId: compute.disks.resize + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the persistent disk. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksResizeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.disks.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.disks.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on a disk. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.disks.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.disks.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks +servers: +- url: https://compute.googleapis.com/compute/v1 +tags: +- name: acceleratorTypes +- name: addresses +- name: autoscalers +- name: backendBuckets +- name: backendServices +- name: disks +- name: diskTypes +- name: externalVpnGateways +- name: firewallPolicies +- name: firewalls +- name: forwardingRules +- name: globalAddresses +- name: globalForwardingRules +- name: globalNetworkEndpointGroups +- name: globalOperations +- name: globalOrganizationOperations +- name: globalPublicDelegatedPrefixes +- name: healthChecks +- name: httpHealthChecks +- name: httpsHealthChecks +- name: imageFamilyViews +- name: images +- name: instanceGroupManagers +- name: instanceGroups +- name: instances +- name: instanceTemplates +- name: interconnectAttachments +- name: interconnectLocations +- name: interconnects +- name: licenseCodes +- name: licenses +- name: machineTypes +- name: networkEndpointGroups +- name: networks +- name: nodeGroups +- name: nodeTemplates +- name: nodeTypes +- name: packetMirrorings +- name: projects +- name: publicAdvertisedPrefixes +- name: publicDelegatedPrefixes +- name: regionAutoscalers +- name: regionBackendServices +- name: regionCommitments +- name: regionDisks +- name: regionDiskTypes +- name: regionHealthChecks +- name: regionHealthCheckServices +- name: regionInstanceGroupManagers +- name: regionInstanceGroups +- name: regionInstances +- name: regionNetworkEndpointGroups +- name: regionNotificationEndpoints +- name: regionOperations +- name: regions +- name: regionSslCertificates +- name: regionTargetHttpProxies +- name: regionTargetHttpsProxies +- name: regionUrlMaps +- name: reservations +- name: resourcePolicies +- name: routers +- name: routes +- name: securityPolicies +- name: serviceAttachments +- name: snapshots +- name: sslCertificates +- name: sslPolicies +- name: subnetworks +- name: targetGrpcProxies +- name: targetHttpProxies +- name: targetHttpsProxies +- name: targetInstances +- name: targetPools +- name: targetSslProxies +- name: targetTcpProxies +- name: targetVpnGateways +- name: urlMaps +- name: vpnGateways +- name: vpnTunnels +- name: zoneOperations +- name: zones diff --git a/test/registry/src/googleapis.com/v1/services-split/compute/compute-disks-v1.yaml.sig b/test/registry/src/googleapis.com/v1/services-split/compute/compute-disks-v1.yaml.sig new file mode 100644 index 00000000..a8447c50 --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services-split/compute/compute-disks-v1.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELaDEEZqAKU3d2w0rv8iIkJvAa4wDHj8kqzN8Nbh+UM/vO2hbt1n5vVLPCLbTXhUNUT4OF+cVHpuIigkbNAiU8E9zInHUPOAQ== \ No newline at end of file diff --git a/test/registry/src/googleapis.com/v1/services-split/compute/compute-v1.yaml b/test/registry/src/googleapis.com/v1/services-split/compute/compute-v1.yaml new file mode 100644 index 00000000..a3dec98b --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services-split/compute/compute-v1.yaml @@ -0,0 +1,74397 @@ +components: + parameters: + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + enum: + - '1' + - '2' + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + enum: + - json + - media + - proto + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: API key. Your API key identifies your project and provides you + with API access, quota, and reports. Required unless you provide an OAuth + 2.0 token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: Available to use for quota purposes for server-side applications. + Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + in: query + name: quotaUser + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + userIp: + description: Legacy name for parameter that has been superseded by `quotaUser`. + in: query + name: userIp + schema: + type: string + schemas: + AcceleratorConfig: + description: A specification of the type and number of accelerator cards attached + to the instance. + properties: + acceleratorCount: + description: The number of the guest accelerator cards exposed to this instance. + format: int32 + type: integer + acceleratorType: + description: 'Full or partial URL of the accelerator type resource to attach + to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 + If you are creating an instance template, specify only the accelerator + name. See GPUs on Compute Engine for a full list of accelerator types.' + type: string + type: object + AcceleratorType: + description: Represents an Accelerator Type resource. Google Cloud Platform + provides graphics processing units (accelerators) that you can add to VM instances + to improve or accelerate performance when working with intensive workloads. + For more information, read GPUs on Compute Engine. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + accelerator type.' + description: + description: '[Output Only] An optional textual description of the resource.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#acceleratorType + description: '[Output Only] The type of the resource. Always compute#acceleratorType + for accelerator types.' + type: string + maximumCardsPerInstance: + description: '[Output Only] Maximum number of accelerator cards allowed + per instance.' + format: int32 + type: integer + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + selfLink: + description: '[Output Only] Server-defined, fully qualified URL for this + resource.' + type: string + zone: + description: '[Output Only] The name of the zone where the accelerator type + resides, such as us-central1-a. You must specify this field as part of + the HTTP request URL. It is not settable as a field in the request body.' + type: string + type: object + AcceleratorTypeAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/AcceleratorTypesScopedList' + description: '[Output Only] Name of the scope containing this set of accelerator + types.' + description: A list of AcceleratorTypesScopedList resources. + type: object + kind: + default: compute#acceleratorTypeAggregatedList + description: '[Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList + for aggregated lists of accelerator types.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AcceleratorTypeList: + description: Contains a list of accelerator types. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of AcceleratorType resources. + items: + $ref: '#/components/schemas/AcceleratorType' + type: array + kind: + default: compute#acceleratorTypeList + description: '[Output Only] Type of resource. Always compute#acceleratorTypeList + for lists of accelerator types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AcceleratorTypesScopedList: + properties: + acceleratorTypes: + description: '[Output Only] A list of accelerator types contained in this + scope.' + items: + $ref: '#/components/schemas/AcceleratorType' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + accelerator types 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AccessConfig: + description: An access configuration attached to an instance's network interface. + Only one access config per instance is supported. + properties: + externalIpv6: + description: '[Output Only] The first IPv6 address of the external IPv6 + range associated with this instance, prefix length is stored in externalIpv6PrefixLength + in ipv6AccessConfig. The field is output only, an IPv6 address from a + subnetwork associated with the instance will be allocated dynamically.' + type: string + externalIpv6PrefixLength: + description: '[Output Only] The prefix length of the external IPv6 range.' + format: int32 + type: integer + kind: + default: compute#accessConfig + description: '[Output Only] Type of the resource. Always compute#accessConfig + for access configs.' + type: string + name: + description: The name of this access configuration. The default and recommended + name is External NAT, but you can use any arbitrary string, such as My + external IP or Network Access. + type: string + natIP: + description: An external IP address associated with this instance. Specify + an unused static external IP address available to the project or leave + this field undefined to use an IP from a shared ephemeral IP address pool. + If you specify a static external IP address, it must live in the same + region as the zone of the instance. + type: string + networkTier: + description: 'This signifies the networking tier used for configuring this + access configuration and can only take the following values: PREMIUM, + STANDARD. If an AccessConfig is specified without a valid external IP + address, an ephemeral IP will be created with this networkTier. If an + AccessConfig with a valid external IP address is specified, it must match + that of the networkTier associated with the Address resource owning that + IP.' + enum: + - PREMIUM + - STANDARD + type: string + publicPtrDomainName: + description: The DNS domain name for the public PTR record. You can set + this field only if the `setPublicPtr` field is enabled in accessConfig. + If this field is unspecified in ipv6AccessConfig, a default PTR record + will be createc for first IP in associated external IPv6 range. + type: string + setPublicPtr: + description: Specifies whether a public DNS 'PTR' record should be created + to map the external IP address of the instance to a DNS domain name. This + field is not used in ipv6AccessConfig. A default PTR record will be created + if the VM has external IPv6 range associated. + type: boolean + type: + default: ONE_TO_ONE_NAT + description: The type of configuration. The default and only option is ONE_TO_ONE_NAT. + enum: + - DIRECT_IPV6 + - ONE_TO_ONE_NAT + type: string + type: object + Address: + description: 'Represents an IP Address resource. Google Compute Engine has two + IP Address resources: * [Global (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses) + * [Regional (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/addresses) + For more information, see Reserving a static external IP address.' + properties: + address: + description: The static IP address represented by this resource. + type: string + addressType: + description: The type of address to reserve, either INTERNAL or EXTERNAL. + If unspecified, defaults to EXTERNAL. + enum: + - EXTERNAL + - INTERNAL + - UNSPECIFIED_TYPE + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this field + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + ipVersion: + description: The IP version that will be used by this address. Valid options + are IPV4 or IPV6. This can only be specified for a global address. + enum: + - IPV4 + - IPV6 + - UNSPECIFIED_VERSION + type: string + kind: + default: compute#address + description: '[Output Only] Type of the resource. Always compute#address + for addresses.' + type: string + name: + description: 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])?`. The first character must be a + lowercase letter, and all following characters (except for the last character) + must be a dash, lowercase letter, or digit. The last character must be + a lowercase letter or digit. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: The URL of the network in which to reserve the address. This + field can only be used with INTERNAL type with the VPC_PEERING purpose. + type: string + networkTier: + description: 'This signifies the networking tier used for configuring this + address and can only take the following values: PREMIUM or STANDARD. Internal + IP addresses are always Premium Tier; global external IP addresses are + always Premium Tier; regional external IP addresses can be either Standard + or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.' + enum: + - PREMIUM + - STANDARD + type: string + prefixLength: + description: The prefix length if the resource represents an IP range. + format: int32 + type: integer + purpose: + description: 'The purpose of this resource, which can be one of the following + values: - GCE_ENDPOINT for addresses that are used by VM instances, alias + IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a + DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder + IP addresses (regional internal IP address in a subnet of a VPC network) + - VPC_PEERING for global internal IP addresses used for private services + access allocated ranges. - NAT_AUTO for the regional external IP addresses + used by Cloud NAT when allocating addresses using . - IPSEC_INTERCONNECT + for addresses created from a private IP range that are reserved for a + VLAN attachment in an *IPsec-encrypted Cloud Interconnect* configuration. + These addresses are regional resources. Not currently available publicly. + - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned + to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for + a private network address that is used to configure Private Service Connect. + Only global internal addresses can use this purpose. ' + enum: + - DNS_RESOLVER + - GCE_ENDPOINT + - IPSEC_INTERCONNECT + - NAT_AUTO + - PRIVATE_SERVICE_CONNECT + - SHARED_LOADBALANCER_VIP + - VPC_PEERING + type: string + region: + description: '[Output Only] The URL of the region where a regional address + resides. For regional addresses, you must specify the region as a path + parameter in the HTTP request URL. *This field is not applicable to global + addresses.*' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of the address, which can be one + of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently + in the process of being reserved. A RESERVED address is currently reserved + and available to use. An IN_USE address is currently being used by another + resource and is not available.' + enum: + - IN_USE + - RESERVED + - RESERVING + type: string + subnetwork: + description: The URL of the subnetwork in which to reserve the address. + If an IP address is specified, it must be within the subnetwork's IP range. + This field can only be used with INTERNAL type with a GCE_ENDPOINT or + DNS_RESOLVER purpose. + type: string + users: + description: '[Output Only] The URLs of the resources that are using this + address.' + items: + type: string + type: array + type: object + AddressAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/AddressesScopedList' + description: '[Output Only] Name of the scope containing this set of addresses.' + description: A list of AddressesScopedList resources. + type: object + kind: + default: compute#addressAggregatedList + description: '[Output Only] Type of resource. Always compute#addressAggregatedList + for aggregated lists of addresses.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AddressList: + description: Contains a list of addresses. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Address resources. + items: + $ref: '#/components/schemas/Address' + type: array + kind: + default: compute#addressList + description: '[Output Only] Type of resource. Always compute#addressList + for lists of addresses.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AddressesScopedList: + properties: + addresses: + description: '[Output Only] A list of addresses contained in this scope.' + items: + $ref: '#/components/schemas/Address' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of addresses 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AdvancedMachineFeatures: + description: Specifies options for controlling advanced machine features. Options + that would traditionally be configured in a BIOS belong here. Features that + require operating system support may have corresponding entries in the GuestOsFeatures + of an Image (e.g., whether or not the OS in the Image supports nested virtualization + being enabled or disabled). + properties: + enableNestedVirtualization: + description: Whether to enable nested virtualization or not (default is + false). + type: boolean + threadsPerCore: + description: The number of threads per physical core. To disable simultaneous + multithreading (SMT) set this to 1. If unset, the maximum number of threads + supported per core by the underlying processor is assumed. + format: int32 + type: integer + type: object + AliasIpRange: + description: An alias IP range attached to an instance's network interface. + properties: + ipCidrRange: + description: The IP alias ranges to allocate for this interface. This IP + CIDR range must belong to the specified subnetwork and cannot contain + IP addresses reserved by system or used by other network interfaces. This + range may be a single IP address (such as 10.2.3.4), a netmask (such as + /24) or a CIDR-formatted string (such as 10.1.2.0/24). + type: string + subnetworkRangeName: + description: The name of a subnetwork secondary IP range from which to allocate + an IP alias range. If not specified, the primary range of the subnetwork + is used. + type: string + type: object + AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk: + properties: + diskSizeGb: + description: Specifies the size of the disk in base-2 GB. + format: int64 + type: string + interface: + description: Specifies the disk interface to use for attaching this disk, + which is either SCSI or NVME. The default is SCSI. For performance characteristics + of SCSI over NVMe, see Local SSD performance. + enum: + - NVME + - SCSI + type: string + type: object + AllocationSpecificSKUAllocationReservedInstanceProperties: + description: 'Properties of the SKU instances being reserved. Next ID: 9' + properties: + guestAccelerators: + description: Specifies accelerator type and count. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + localSsds: + description: Specifies amount of local ssd to reserve with each instance. + The type of disk is local-ssd. + items: + $ref: '#/components/schemas/AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk' + type: array + locationHint: + description: An opaque location hint used to place the allocation close + to other resources. This field is for use by internal tools that use the + public API. + type: string + machineType: + description: Specifies type of machine (name only) which has fixed number + of vCPUs and fixed amount of memory. This also includes specifying custom + machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. + type: string + minCpuPlatform: + description: Minimum cpu platform the reservation. + type: string + type: object + AllocationSpecificSKUReservation: + description: 'This reservation type allows to pre allocate specific instance + configuration. Next ID: 5' + properties: + count: + description: Specifies the number of resources that are allocated. + format: int64 + type: string + inUseCount: + description: '[Output Only] Indicates how many instances are in use.' + format: int64 + type: string + instanceProperties: + $ref: '#/components/schemas/AllocationSpecificSKUAllocationReservedInstanceProperties' + description: The instance properties for the reservation. + type: object + AttachedDisk: + description: An instance-attached disk resource. + properties: + autoDelete: + description: Specifies whether the disk will be auto-deleted when the instance + is deleted (but not when the disk is detached from the instance). + type: boolean + boot: + description: Indicates that this is a boot disk. The virtual machine will + use the first partition of the disk for its root filesystem. + type: boolean + deviceName: + description: Specifies a unique device name of your choice that is reflected + into the /dev/disk/by-id/google-* tree of a Linux operating system running + within the instance. This name can be used to reference the device for + mounting, resizing, and so on, from within the instance. If not specified, + the server chooses a default device name to apply to this disk, in the + form persistent-disk-x, where x is a number assigned by Google Compute + Engine. This field is only applicable for persistent disks. + type: string + diskEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: Encrypts or decrypts a disk using a customer-supplied encryption + key. If you are creating a new disk, this field encrypts the new disk + using an encryption key that you provide. If you are attaching an existing + disk that is already encrypted, this field decrypts the disk using the + customer-supplied encryption key. If you encrypt a disk using a customer-supplied + key, you must provide the same key again when you attempt to use this + resource at a later time. For example, you must provide the key when you + create a snapshot or an image from the disk or when you attach the disk + to a virtual machine instance. If you do not provide an encryption key, + then the disk will be encrypted using an automatically generated key and + you do not need to provide a key to use the disk later. Instance templates + do not store customer-supplied encryption keys, so you cannot use your + own keys to encrypt disks in a managed instance group. + diskSizeGb: + description: The size of the disk in GB. + format: int64 + type: string + 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. + items: + $ref: '#/components/schemas/GuestOsFeature' + type: array + index: + description: '[Output Only] A zero-based index to this disk, where 0 is + reserved for the boot disk. If you have many disks attached to an instance, + each disk would have a unique index number.' + format: int32 + type: integer + initializeParams: + $ref: '#/components/schemas/AttachedDiskInitializeParams' + description: '[Input Only] Specifies the parameters for a new disk that + will be created alongside the new instance. Use initialization parameters + to create boot disks or local SSDs attached to the new instance. This + property is mutually exclusive with the source property; you can only + define one or the other, but not both.' + interface: + description: Specifies the disk interface to use for attaching this disk, + which is either SCSI or NVME. The default is SCSI. Persistent disks must + always use SCSI and the request will fail if you attempt to attach a persistent + disk in any other format than SCSI. Local SSDs can use either NVME or + SCSI. For performance characteristics of SCSI over NVMe, see Local SSD + performance. + enum: + - NVME + - SCSI + type: string + kind: + default: compute#attachedDisk + description: '[Output Only] Type of the resource. Always compute#attachedDisk + for attached disks.' + type: string + licenses: + description: '[Output Only] Any valid publicly visible licenses.' + items: + type: string + type: array + mode: + description: The mode in which to attach this disk, either READ_WRITE or + READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE + mode. + enum: + - READ_ONLY + - READ_WRITE + type: string + shieldedInstanceInitialState: + $ref: '#/components/schemas/InitialStateConfig' + description: '[Output Only] shielded vm initial state stored on disk' + source: + description: Specifies a valid partial or full URL to an existing Persistent + Disk resource. When creating a new instance, one of initializeParams.sourceImage + or initializeParams.sourceSnapshot or disks.source is required except + for local SSD. If desired, you can also attach existing non-root persistent + disks using this property. This field is only applicable for persistent + disks. Note that for InstanceTemplate, specify the disk name, not the + URL for the disk. + type: string + type: + description: Specifies the type of the disk, either SCRATCH or PERSISTENT. + If not specified, the default is PERSISTENT. + enum: + - PERSISTENT + - SCRATCH + type: string + type: object + AttachedDiskInitializeParams: + description: '[Input Only] Specifies the parameters for a new disk that will + be created alongside the new instance. Use initialization parameters to create + boot disks or local SSDs attached to the new instance. This property is mutually + exclusive with the source property; you can only define one or the other, + but not both.' + properties: + description: + description: An optional description. Provide this property when creating + the disk. + type: string + diskName: + description: 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. + type: string + diskSizeGb: + description: 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. + format: int64 + type: string + diskType: + 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 define this field, you can provide either the full + or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - + zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is + the name of the disk type, not URL.' + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this disk. These can be later modified by + the disks.setLabels method. This field is only applicable for persistent + disks. + type: object + onUpdateAction: + description: Specifies which action to take on instance update with this + disk. Default is to use the existing disk. + enum: + - RECREATE_DISK + - RECREATE_DISK_IF_SOURCE_CHANGED + - USE_EXISTING_DISK + type: string + provisionedIops: + description: Indicates how many IOPS to provision for the disk. This sets + the number of I/O operations per second that the disk can handle. Values + must be between 10,000 and 120,000. For more details, see the Extreme + persistent disk documentation. + format: int64 + type: string + resourcePolicies: + description: Resource policies applied to this disk for automatic snapshot + creations. Specified using the full or partial URL. For instance template, + specify only the resource policy name. + items: + type: string + type: array + sourceImage: + description: 'The source image to create this disk. When creating a new + instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot + or disks.source is required except for local SSD. To create a disk with + one of the public operating system images, specify the image by its family + name. For example, specify family/debian-9 to use the latest Debian 9 + image: projects/debian-cloud/global/images/family/debian-9 Alternatively, + use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD + To create a disk with a custom image that you created, specify the image + name in the following format: global/images/my-custom-image You can also + specify a custom image by its image family, which returns the latest version + of the image in that family. Replace the image name with family/family-name: + global/images/family/my-image-family If the source image is deleted later, + this field will not be set.' + type: string + sourceImageEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption key. + Instance templates do not store customer-supplied encryption keys, so + you cannot create disks for instances in a managed instance group if the + source images are encrypted with your own keys. + sourceSnapshot: + description: 'The source snapshot to create this disk. When creating a new + instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage + or disks.source is required except for local SSD. To create a disk with + a snapshot that you created, specify the snapshot name in the following + format: global/snapshots/my-backup If the source snapshot is deleted later, + this field will not be set.' + type: string + sourceSnapshotEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source snapshot. + type: object + AuditConfig: + description: 'Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if any, + are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. + If there are AuditConfigs for both `allServices` and a specific service, the + union of the two AuditConfigs is used for that service: the log_types specified + in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig + are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": + [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" + }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", + "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", + "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, + this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also + exempts jose@example.com from DATA_READ logging, and aliya@example.com from + DATA_WRITE logging.' + properties: + auditLogConfigs: + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/AuditLogConfig' + type: array + exemptedMembers: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + service: + description: Specifies a service that will be enabled for audit logging. + For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` + is a special value that covers all services. + type: string + type: object + AuditLogConfig: + description: 'Provides the configuration for logging a type of permissions. + Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": + [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables + ''DATA_READ'' and ''DATA_WRITE'' logging, while exempting jose@example.com + from DATA_READ logging.' + properties: + exemptedMembers: + description: Specifies the identities that do not cause logging for this + type of permission. Follows the same format of Binding.members. + items: + type: string + type: array + ignoreChildExemptions: + description: This is deprecated and has no effect. Do not use. + type: boolean + logType: + description: The log type that this config enables. + enum: + - ADMIN_READ + - DATA_READ + - DATA_WRITE + - LOG_TYPE_UNSPECIFIED + type: string + type: object + AuthorizationLoggingOptions: + description: This is deprecated and has no effect. Do not use. + properties: + permissionType: + description: This is deprecated and has no effect. Do not use. + enum: + - ADMIN_READ + - ADMIN_WRITE + - DATA_READ + - DATA_WRITE + - PERMISSION_TYPE_UNSPECIFIED + type: string + type: object + Autoscaler: + description: 'Represents an Autoscaler resource. Google Compute Engine has two + Autoscaler resources: * [Zonal](/compute/docs/reference/rest/v1/autoscalers) + * [Regional](/compute/docs/reference/rest/v1/regionAutoscalers) Use autoscalers + to automatically add or delete instances from a managed instance group according + to your defined autoscaling policy. For more information, read Autoscaling + Groups of Instances. For zonal managed instance groups resource, use the autoscaler + resource. For regional managed instance groups, use the regionAutoscalers + resource.' + properties: + autoscalingPolicy: + $ref: '#/components/schemas/AutoscalingPolicy' + description: 'The configuration parameters for the autoscaling algorithm. + You can define one or more signals for an autoscaler: cpuUtilization, + customMetricUtilizations, and loadBalancingUtilization. If none of these + are specified, the default will be to autoscale based on cpuUtilization + to 0.6 or 60%.' + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#autoscaler + description: '[Output Only] Type of the resource. Always compute#autoscaler + for autoscalers.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + recommendedSize: + description: '[Output Only] Target recommended MIG size (number of instances) + computed by autoscaler. Autoscaler calculates the recommended MIG size + even when the autoscaling policy mode is different from ON. This field + is empty when autoscaler is not connected to an existing managed instance + group or autoscaler did not generate its prediction.' + format: int32 + type: integer + region: + description: '[Output Only] URL of the region where the instance group resides + (for autoscalers living in regional scope).' + type: string + scalingScheduleStatus: + additionalProperties: + $ref: '#/components/schemas/ScalingScheduleStatus' + description: '[Output Only] Status information of existing scaling schedules.' + type: object + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of the autoscaler configuration. + Current set of possible values: - PENDING: Autoscaler backend hasn''t + read new/updated configuration. - DELETING: Configuration is being deleted. + - ACTIVE: Configuration is acknowledged to be effective. Some warnings + might be present in the statusDetails field. - ERROR: Configuration has + errors. Actionable for users. Details are present in the statusDetails + field. New values might be added in the future.' + enum: + - ACTIVE + - DELETING + - ERROR + - PENDING + type: string + statusDetails: + description: '[Output Only] Human-readable details about the current state + of the autoscaler. Read the documentation for Commonly returned status + messages for examples of status messages you might encounter.' + items: + $ref: '#/components/schemas/AutoscalerStatusDetails' + type: array + target: + description: URL of the managed instance group that this autoscaler will + scale. This field is required when creating an autoscaler. + type: string + zone: + description: '[Output Only] URL of the zone where the instance group resides + (for autoscalers living in zonal scope).' + type: string + type: object + AutoscalerAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/AutoscalersScopedList' + description: '[Output Only] Name of the scope containing this set of autoscalers.' + description: A list of AutoscalersScopedList resources. + type: object + kind: + default: compute#autoscalerAggregatedList + description: '[Output Only] Type of resource. Always compute#autoscalerAggregatedList + for aggregated lists of autoscalers.' + 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 + unreachables: + description: '[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AutoscalerList: + description: Contains a list of Autoscaler resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Autoscaler resources. + items: + $ref: '#/components/schemas/Autoscaler' + type: array + kind: + default: compute#autoscalerList + description: '[Output Only] Type of resource. Always compute#autoscalerList + for lists of autoscalers.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AutoscalerStatusDetails: + properties: + message: + description: The status message. + type: string + type: + description: 'The type of error, warning, or notice returned. Current set + of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances + in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST + (ERROR): There is no backend service attached to the instance group. - + CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater + than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): + The custom metric samples are not exported often enough to be a credible + base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric + that was specified does not exist or does not have the necessary labels. + - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. + This means the autoscaler cannot add or remove instances from the instance + group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did + not receive any data from the custom metric configured for autoscaling. + - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured + to scale based on a load balancing signal but the instance group has not + received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling + is turned off. The number of instances in the group won''t change automatically. + The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): + Autoscaling is in the "Autoscale only out" mode. The autoscaler can add + instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): + The instance group cannot be autoscaled because it has more than one backend + service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is + insufficient quota for the necessary resources, such as CPU or number + of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional + autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST + (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION + (ERROR): Autoscaling does not work with an HTTP/S load balancer that has + been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal + autoscalers: there is a resource stockout in the chosen zone. For regional + autoscalers: in at least one of the zones you''re using there is a resource + stockout. New values might be added in the future. Some of the values + might not be available in all API versions.' + enum: + - ALL_INSTANCES_UNHEALTHY + - BACKEND_SERVICE_DOES_NOT_EXIST + - CAPPED_AT_MAX_NUM_REPLICAS + - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE + - CUSTOM_METRIC_INVALID + - MIN_EQUALS_MAX + - MISSING_CUSTOM_METRIC_DATA_POINTS + - MISSING_LOAD_BALANCING_DATA_POINTS + - MODE_OFF + - MODE_ONLY_SCALE_OUT + - MODE_ONLY_UP + - MORE_THAN_ONE_BACKEND_SERVICE + - NOT_ENOUGH_QUOTA_AVAILABLE + - REGION_RESOURCE_STOCKOUT + - SCALING_TARGET_DOES_NOT_EXIST + - SCHEDULED_INSTANCES_GREATER_THAN_AUTOSCALER_MAX + - SCHEDULED_INSTANCES_LESS_THAN_AUTOSCALER_MIN + - UNKNOWN + - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION + - ZONE_RESOURCE_STOCKOUT + type: string + type: object + AutoscalersScopedList: + properties: + autoscalers: + description: '[Output Only] A list of autoscalers contained in this scope.' + items: + $ref: '#/components/schemas/Autoscaler' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of autoscalers 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + AutoscalingPolicy: + description: Cloud Autoscaler policy. + properties: + coolDownPeriodSec: + description: The number of seconds that the autoscaler waits before it starts + collecting information from a new instance. This prevents the autoscaler + from collecting information when the instance is initializing, during + which the collected usage would not be reliable. The default time autoscaler + waits is 60 seconds. Virtual machine initialization times might vary because + of numerous factors. We recommend that you test how long an instance may + take to initialize. To do this, create an instance and time the startup + process. + format: int32 + type: integer + cpuUtilization: + $ref: '#/components/schemas/AutoscalingPolicyCpuUtilization' + description: Defines the CPU utilization policy that allows the autoscaler + to scale based on the average CPU utilization of a managed instance group. + customMetricUtilizations: + description: Configuration parameters of autoscaling based on a custom metric. + items: + $ref: '#/components/schemas/AutoscalingPolicyCustomMetricUtilization' + type: array + loadBalancingUtilization: + $ref: '#/components/schemas/AutoscalingPolicyLoadBalancingUtilization' + description: Configuration parameters of autoscaling based on load balancer. + maxNumReplicas: + description: The maximum number of instances that the autoscaler can scale + out to. This is required when creating or updating an autoscaler. The + maximum number of replicas must not be lower than minimal number of replicas. + format: int32 + type: integer + minNumReplicas: + description: The minimum number of replicas that the autoscaler can scale + in to. This cannot be less than 0. If not provided, autoscaler chooses + a default value depending on maximum number of instances allowed. + format: int32 + type: integer + mode: + description: Defines operating mode for this policy. + enum: + - false + - true + - ONLY_SCALE_OUT + - ONLY_UP + type: string + scaleInControl: + $ref: '#/components/schemas/AutoscalingPolicyScaleInControl' + scalingSchedules: + additionalProperties: + $ref: '#/components/schemas/AutoscalingPolicyScalingSchedule' + description: Scaling schedules defined for an autoscaler. Multiple schedules + can be set on an autoscaler, and they can overlap. During overlapping + periods the greatest min_required_replicas of all scaling schedules is + applied. Up to 128 scaling schedules are allowed. + type: object + type: object + AutoscalingPolicyCpuUtilization: + description: CPU utilization policy. + properties: + predictiveMethod: + description: 'Indicates whether predictive autoscaling based on CPU metric + is enabled. Valid values are: * NONE (default). No predictive method is + used. The autoscaler scales the group to meet current demand based on + real-time metrics. * OPTIMIZE_AVAILABILITY. Predictive autoscaling improves + availability by monitoring daily and weekly load patterns and scaling + out ahead of anticipated demand.' + enum: + - NONE + - OPTIMIZE_AVAILABILITY + type: string + utilizationTarget: + description: The target CPU utilization that the autoscaler maintains. Must + be a float value in the range (0, 1]. If not specified, the default is + 0.6. If the CPU level is below the target utilization, the autoscaler + scales in the number of instances until it reaches the minimum number + of instances you specified or until the average CPU of your instances + reaches the target utilization. If the average CPU is above the target + utilization, the autoscaler scales out until it reaches the maximum number + of instances you specified or until the average utilization reaches the + target utilization. + format: double + type: number + type: object + AutoscalingPolicyCustomMetricUtilization: + description: Custom utilization metric policy. + properties: + filter: + description: 'A filter string, compatible with a Stackdriver Monitoring + filter string for TimeSeries.list API call. This filter is used to select + a specific TimeSeries for the purpose of autoscaling and to determine + whether the metric is exporting per-instance or per-group data. For the + filter to be valid for autoscaling purposes, the following rules apply: + - You can only use the AND operator for joining selectors. - You can only + use direct equality comparison operator (=) without any functions for + each selector. - You can specify the metric in both the filter string + and in the metric field. However, if specified in both places, the metric + must be identical. - The monitored resource type determines what kind + of values are expected for the metric. If it is a gce_instance, the autoscaler + expects the metric to include a separate TimeSeries for each instance + in a group. In such a case, you cannot filter on resource labels. If the + resource type is any other value, the autoscaler expects this metric to + contain values that apply to the entire autoscaled instance group and + resource label filtering can be performed to point autoscaler at the correct + TimeSeries to scale upon. This is called a *per-group metric* for the + purpose of autoscaling. If not specified, the type defaults to gce_instance. + Try to provide a filter that is selective enough to pick just one TimeSeries + for the autoscaled group or for each of the instances (if you are using + gce_instance resource type). If multiple TimeSeries are returned upon + the query execution, the autoscaler will sum their respective values to + obtain its scaling value.' + type: string + metric: + description: The identifier (type) of the Stackdriver Monitoring metric. + The metric cannot have negative values. The metric must have a value type + of INT64 or DOUBLE. + type: string + singleInstanceAssignment: + description: If scaling is based on a per-group metric value that represents + the total amount of work to be done or resource usage, set this value + to an amount assigned for a single instance of the scaled group. Autoscaler + keeps the number of instances proportional to the value of this metric. + The metric itself does not change value due to group resizing. A good + metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages + or a custom metric exporting the total number of requests coming to your + instances. A bad example would be a metric exporting an average or median + latency, since this value can't include a chunk assignable to a single + instance, it could be better used with utilization_target instead. + format: double + type: number + utilizationTarget: + description: The target value of the metric that autoscaler maintains. This + must be a positive value. A utilization metric scales number of virtual + machines handling requests to increase or decrease proportionally to the + metric. For example, a good metric to use as a utilization_target is https://www.googleapis.com/compute/v1/instance/network/received_bytes_count. + The autoscaler works to keep this value constant for each of the instances. + format: double + type: number + utilizationTargetType: + description: Defines how target utilization value is expressed for a Stackdriver + Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + enum: + - DELTA_PER_MINUTE + - DELTA_PER_SECOND + - GAUGE + type: string + type: object + AutoscalingPolicyLoadBalancingUtilization: + description: Configuration parameters of autoscaling based on load balancing. + properties: + utilizationTarget: + description: Fraction of backend capacity utilization (set in HTTP(S) load + balancing configuration) that the autoscaler maintains. Must be a positive + float value. If not defined, the default is 0.8. + format: double + type: number + type: object + AutoscalingPolicyScaleInControl: + description: Configuration that allows for slower scale in so that even if Autoscaler + recommends an abrupt scale in of a MIG, it will be throttled as specified + by the parameters below. + properties: + maxScaledInReplicas: + $ref: '#/components/schemas/FixedOrPercent' + description: Maximum allowed number (or %) of VMs that can be deducted from + the peak recommendation during the window autoscaler looks at when computing + recommendations. Possibly all these VMs can be deleted at once so user + service needs to be prepared to lose that many VMs in one step. + timeWindowSec: + description: How far back autoscaling looks when computing recommendations + to include directives regarding slower scale in, as described above. + format: int32 + type: integer + type: object + AutoscalingPolicyScalingSchedule: + description: Scaling based on user-defined schedule. The message describes a + single scaling schedule. A scaling schedule changes the minimum number of + VM instances an autoscaler can recommend, which can trigger scaling out. + properties: + description: + description: A description of a scaling schedule. + type: string + disabled: + description: A boolean value that specifies whether a scaling schedule can + influence autoscaler recommendations. If set to true, then a scaling schedule + has no effect. This field is optional, and its value is false by default. + type: boolean + durationSec: + description: The duration of time intervals, in seconds, for which this + scaling schedule is to run. The minimum allowed value is 300. This field + is required. + format: int32 + type: integer + minRequiredReplicas: + description: The minimum number of VM instances that the autoscaler will + recommend in time intervals starting according to schedule. This field + is required. + format: int32 + type: integer + schedule: + description: 'The start timestamps of time intervals when this scaling schedule + is to provide a scaling signal. This field uses the extended cron format + (with an optional year field). The expression can describe a single timestamp + if the optional year is set, in which case the scaling schedule runs once. + The schedule is interpreted with respect to time_zone. This field is required. + Note: These timestamps only describe when autoscaler starts providing + the scaling signal. The VMs need additional time to become serving.' + type: string + timeZone: + description: "The time zone to use when interpreting the schedule. The value\ + \ of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.\ + \ This field is assigned a default value of \u201CUTC\u201D if left empty." + type: string + type: object + Backend: + description: Message containing information of one individual backend. + properties: + balancingMode: + description: 'Specifies how to determine whether the backend of a load balancer + can handle additional traffic or is fully loaded. For usage guidelines, + see Connection balancing mode. Backends must use compatible balancing + modes. For more information, see Supported balancing modes and target + capacity settings and Restrictions and guidance for instance groups. Note: + Currently, if you use the API to configure incompatible balancing modes, + the configuration might be accepted even though it has no impact and is + ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode + is RATE. In the future, this incompatible combination will be rejected.' + enum: + - CONNECTION + - RATE + - UTILIZATION + type: string + capacityScaler: + description: A multiplier applied to the backend's target capacity of its + balancing mode. The default value is 1, which means the group serves up + to 100% of its configured capacity (depending on balancingMode). A setting + of 0 means the group is completely drained, offering 0% of its available + capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure + a setting larger than 0 and smaller than 0.1. You cannot configure a setting + of 0 when there is only one backend attached to the backend service. + format: float + type: number + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + failover: + description: This field designates whether this is a failover backend. More + than one failover backend can be configured for a given BackendService. + type: boolean + group: + description: The fully-qualified URL of an instance group or network endpoint + group (NEG) resource. To determine what types of backends a load balancer + supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). + You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) + to specify the instance group or NEG. Partial URLs are not supported. + type: string + maxConnections: + description: Defines a target maximum number of simultaneous connections. + For usage guidelines, see Connection balancing mode and Utilization balancing + mode. Not available if the backend's balancingMode is RATE. + format: int32 + type: integer + maxConnectionsPerEndpoint: + description: Defines a target maximum number of simultaneous connections. + For usage guidelines, see Connection balancing mode and Utilization balancing + mode. Not available if the backend's balancingMode is RATE. + format: int32 + type: integer + maxConnectionsPerInstance: + description: Defines a target maximum number of simultaneous connections. + For usage guidelines, see Connection balancing mode and Utilization balancing + mode. Not available if the backend's balancingMode is RATE. + format: int32 + type: integer + maxRate: + description: Defines a maximum number of HTTP requests per second (RPS). + For usage guidelines, see Rate balancing mode and Utilization balancing + mode. Not available if the backend's balancingMode is CONNECTION. + format: int32 + type: integer + maxRatePerEndpoint: + description: Defines a maximum target for requests per second (RPS). For + usage guidelines, see Rate balancing mode and Utilization balancing mode. + Not available if the backend's balancingMode is CONNECTION. + format: float + type: number + maxRatePerInstance: + description: Defines a maximum target for requests per second (RPS). For + usage guidelines, see Rate balancing mode and Utilization balancing mode. + Not available if the backend's balancingMode is CONNECTION. + format: float + type: number + maxUtilization: + description: Optional parameter to define a target capacity for the UTILIZATIONbalancing + mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization + balancing mode. + format: float + type: number + type: object + BackendBucket: + description: Represents a Cloud Storage Bucket resource. This Cloud Storage + bucket resource is referenced by a URL map of a load balancer. For more information, + read Backend Buckets. + properties: + bucketName: + description: Cloud Storage bucket name. + type: string + cdnPolicy: + $ref: '#/components/schemas/BackendBucketCdnPolicy' + description: Cloud CDN configuration for this BackendBucket. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customResponseHeaders: + description: Headers that the HTTP/S load balancer should add to proxied + responses. + items: + type: string + type: array + description: + description: An optional textual description of the resource; provided by + the client when the resource is created. + type: string + enableCdn: + description: If true, enable Cloud CDN for this BackendBucket. + type: boolean + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + format: uint64 + type: string + kind: + default: compute#backendBucket + description: Type of the resource. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + BackendBucketCdnPolicy: + description: Message containing Cloud CDN configuration for a backend bucket. + properties: + bypassCacheOnRequestHeaders: + description: Bypass the cache when the specified request headers are matched + - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. + The cache is bypassed for all cdnPolicy.cacheMode settings. + items: + $ref: '#/components/schemas/BackendBucketCdnPolicyBypassCacheOnRequestHeader' + type: array + cacheMode: + description: 'Specifies the cache setting for all responses from this backend. + The possible values are: USE_ORIGIN_HEADERS Requires the origin to set + valid caching headers to cache content. Responses without these headers + will not be cached at Google''s edge, and will require a full trip to + the origin on every request, potentially impacting performance and increasing + load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring + any "private", "no-store" or "no-cache" directives in Cache-Control response + headers. Warning: this may result in Cloud CDN caching private, per-user + (user identifiable) content. CACHE_ALL_STATIC Automatically cache static + content, including common image formats, media (video and audio), and + web assets (JavaScript and CSS). Requests and responses that are marked + as uncacheable, as well as dynamic content (including HTML), will not + be cached.' + enum: + - CACHE_ALL_STATIC + - FORCE_CACHE_ALL + - INVALID_CACHE_MODE + - USE_ORIGIN_HEADERS + type: string + clientTtl: + description: Specifies a separate client (e.g. browser client) maximum TTL. + This is used to clamp the max-age (or Expires) value sent to the client. + With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used + for the response max-age directive, along with a "public" directive. For + cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age + from the origin (if specified), or else sets the response max-age directive + to the lesser of the client_ttl and default_ttl, and also ensures a "public" + cache-control directive is present. If a client TTL is not specified, + a default value (1 hour) will be used. The maximum allowed value is 31,622,400s + (1 year). + format: int32 + type: integer + defaultTtl: + description: Specifies the default TTL for cached content served by this + origin for responses that do not have an existing valid TTL (max-age or + s-max-age). Setting a TTL of "0" means "always revalidate". The value + of defaultTTL cannot be set to a value greater than that of maxTTL, but + can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL + will overwrite the TTL set in all responses. The maximum allowed value + is 31,622,400s (1 year), noting that infrequently accessed objects may + be evicted from the cache before the defined TTL. + format: int32 + type: integer + maxTtl: + description: Specifies the maximum allowed TTL for cached content served + by this origin. Cache directives that attempt to set a max-age or s-maxage + higher than this, or an Expires header more than maxTTL seconds in the + future will be capped at the value of maxTTL, as if it were the value + of an s-maxage Cache-Control directive. Headers sent to the client will + not be modified. Setting a TTL of "0" means "always revalidate". The maximum + allowed value is 31,622,400s (1 year), noting that infrequently accessed + objects may be evicted from the cache before the defined TTL. + format: int32 + type: integer + negativeCaching: + description: 'Negative caching allows per-status code TTLs to be set, in + order to apply fine-grained caching for common errors or redirects. This + can reduce the load on your origin and improve end-user experience by + reducing response latency. When the cache mode is set to CACHE_ALL_STATIC + or USE_ORIGIN_HEADERS, negative caching applies to responses with the + specified response code that lack any Cache-Control, Expires, or Pragma: + no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative + caching applies to all responses with the specified response code, and + override any caching headers. By default, Cloud CDN will apply the following + default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 + (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable + For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected + Request), 501 (Not Implemented): 60s. These defaults can be overridden + in negative_caching_policy.' + type: boolean + negativeCachingPolicy: + description: Sets a cache TTL for the specified HTTP status code. negative_caching + must be enabled to configure negative_caching_policy. Omitting the policy + and leaving negative_caching enabled will use Cloud CDN's default cache + TTLs. Note that when specifying an explicit negative_caching_policy, you + should take care to specify a cache TTL for all response codes that you + wish to cache. Cloud CDN will not apply any default negative caching when + a policy exists. + items: + $ref: '#/components/schemas/BackendBucketCdnPolicyNegativeCachingPolicy' + type: array + requestCoalescing: + description: If true then Cloud CDN will combine multiple concurrent cache + fill requests into a small number of requests to the origin. + type: boolean + serveWhileStale: + description: Serve existing content from the cache (if available) when revalidating + content with the origin, or when an error is encountered when refreshing + the cache. This setting defines the default "max-stale" duration for any + cached responses that do not specify a max-stale directive. Stale responses + that exceed the TTL configured here will not be served. The default limit + (max-stale) is 86400s (1 day), which will allow stale content to be served + up to this limit beyond the max-age (or s-max-age) of a cached response. + The maximum allowed value is 604800 (1 week). Set this to zero (0) to + disable serve-while-stale. + format: int32 + type: integer + signedUrlCacheMaxAgeSec: + description: 'Maximum number of seconds the response to a signed URL request + will be considered fresh. After this time period, the response will be + revalidated before being served. Defaults to 1hr (3600s). When serving + responses to signed URL requests, Cloud CDN will internally behave as + though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" + header, regardless of any existing Cache-Control header. The actual headers + served in responses will not be altered.' + format: int64 + type: string + signedUrlKeyNames: + description: '[Output Only] Names of the keys for signing request URLs.' + items: + type: string + type: array + type: object + BackendBucketCdnPolicyBypassCacheOnRequestHeader: + description: Bypass the cache when the specified request headers are present, + e.g. Pragma or Authorization headers. Values are case insensitive. The presence + of such a header overrides the cache_mode setting. + properties: + headerName: + description: The header field name to match on when bypassing cache. Values + are case-insensitive. + type: string + type: object + BackendBucketCdnPolicyNegativeCachingPolicy: + description: Specify CDN TTLs for response error codes. + properties: + code: + description: The HTTP status code to define a TTL against. Only HTTP status + codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can + be specified as values, and you cannot specify a status code more than + once. + format: int32 + type: integer + ttl: + description: The TTL (in seconds) for which to cache responses with the + corresponding status code. The maximum allowed value is 1800s (30 minutes), + noting that infrequently accessed objects may be evicted from the cache + before the defined TTL. + format: int32 + type: integer + type: object + BackendBucketList: + description: Contains a list of BackendBucket resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of BackendBucket resources. + items: + $ref: '#/components/schemas/BackendBucket' + type: array + kind: + default: compute#backendBucketList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + BackendService: + description: Represents a Backend Service resource. A backend service defines + how Google Cloud load balancers distribute traffic. The backend service configuration + contains a set of values, such as the protocol used to connect to backends, + various distribution and session settings, health checks, and timeouts. These + settings provide fine-grained control over how your load balancer behaves. + Most of the settings have default values that allow for easy configuration + if you need to get started quickly. Backend services in Google Compute Engine + can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) + * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) + For more information, see Backend Services. + properties: + affinityCookieTtlSec: + description: Lifetime of cookies in seconds. This setting is applicable + to external and internal HTTP(S) load balancers and Traffic Director and + requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, + the cookie is non-persistent and lasts only until the end of the browser + session (or equivalent). The maximum allowed value is one day (86,400). + 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. + format: int32 + type: integer + backends: + description: The list of backends that serve this BackendService. + items: + $ref: '#/components/schemas/Backend' + type: array + cdnPolicy: + $ref: '#/components/schemas/BackendServiceCdnPolicy' + description: Cloud CDN configuration for this BackendService. Only available + for specified load balancer types. + circuitBreakers: + $ref: '#/components/schemas/CircuitBreakers' + connectionDraining: + $ref: '#/components/schemas/ConnectionDraining' + consistentHash: + $ref: '#/components/schemas/ConsistentHashLoadBalancerSettings' + description: 'Consistent Hash-based load balancing can be used to provide + soft session affinity based on HTTP headers, cookies or other properties. + This load balancing policy is applicable only for HTTP connections. The + affinity to a particular destination host will be lost when one or more + hosts are added/removed from the destination service. This field specifies + parameters that control consistent hashing. This field is only applicable + when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable + to either: - A regional backend service with the service_protocol set + to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. + - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + 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.' + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customRequestHeaders: + description: Headers that the load balancer adds to proxied requests. See + [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). + items: + type: string + type: array + customResponseHeaders: + description: Headers that the load balancer adds to proxied responses. See + [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). + items: + type: string + type: array + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + enableCDN: + description: If true, enables Cloud CDN for the backend service of an external + HTTP(S) load balancer. + type: boolean + failoverPolicy: + $ref: '#/components/schemas/BackendServiceFailoverPolicy' + description: 'Requires at least one backend instance group to be defined + as a backup (failover) backend. For load balancers that have configurable + failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external TCP/UDP Load Balancing](/network/networklb-failover-overview).' + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a BackendService. An up-to-date fingerprint + must be provided in order to update the BackendService, otherwise the + request will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve a BackendService. + format: byte + type: string + healthChecks: + description: The list of URLs to the healthChecks, httpHealthChecks (legacy), + or httpsHealthChecks (legacy) resource for health checking this backend + service. Not all backend services support legacy health checks. See Load + balancer guide. Currently, at most one health check can be specified for + each backend service. Backend services with instance group or zonal NEG + backends must have a health check. Backend services with internet or serverless + NEG backends must not have a health check. + items: + type: string + type: array + iap: + $ref: '#/components/schemas/BackendServiceIAP' + description: The configurations for Identity-Aware Proxy on this resource. + Not available for Internal TCP/UDP Load Balancing and Network Load Balancing. + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#backendService + description: '[Output Only] Type of resource. Always compute#backendService + for backend services.' + type: string + loadBalancingScheme: + description: Specifies the load balancer type. A backend service created + for one type of load balancer cannot be used with another. For more information, + refer to Choosing a load balancer. + enum: + - EXTERNAL + - INTERNAL + - INTERNAL_MANAGED + - INTERNAL_SELF_MANAGED + - INVALID_LOAD_BALANCING_SCHEME + type: string + localityLbPolicy: + description: 'The load balancing algorithm used within the scope of the + locality. The possible values are: - ROUND_ROBIN: This is a simple policy + in which each healthy backend is selected in round robin order. This is + the default. - LEAST_REQUEST: An O(1) algorithm which selects two random + healthy hosts and picks the host which has fewer active requests. - RING_HASH: + The ring/modulo hash load balancer implements consistent hashing to backends. + The algorithm has the property that the addition/removal of a host from + a set of N hosts only affects 1/N of the requests. - RANDOM: The load + balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend + host is selected based on the client connection metadata, i.e., connections + are opened to the same address as the destination address of the incoming + connection before the connection was redirected to the load balancer. + - MAGLEV: used as a drop in replacement for the ring hash load balancer. + Maglev is not as stable as ring hash but has faster table lookup build + times and host selection times. For more information about Maglev, see + https://ai.google/research/pubs/pub44824 This field is applicable to either: + - A regional backend service with the service_protocol set to HTTP, HTTPS, + or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global + backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + If sessionAffinity is not NONE, and this field is not set to MAGLEV or + RING_HASH, session affinity settings will not take effect. Only the default + ROUND_ROBIN policy is 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.' + enum: + - INVALID_LB_POLICY + - LEAST_REQUEST + - MAGLEV + - ORIGINAL_DESTINATION + - RANDOM + - RING_HASH + - ROUND_ROBIN + type: string + logConfig: + $ref: '#/components/schemas/BackendServiceLogConfig' + description: This field denotes the logging options for the load balancer + traffic served by this backend service. If logging is enabled, logs will + be exported to Stackdriver. + maxStreamDuration: + $ref: '#/components/schemas/Duration' + description: Specifies the default maximum duration (timeout) for streams + to this service. Duration is computed from the beginning of the stream + until the response has been completely processed, including all retries. + A stream that does not complete in this duration is closed. If not specified, + there will be no timeout limit, i.e. the maximum duration is infinite. + This value can be overridden in the PathMatcher configuration of the UrlMap + that references this backend service. This field is only allowed when + the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED. + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: 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. + type: string + outlierDetection: + $ref: '#/components/schemas/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, or HTTP2, + and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend + service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. 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: + 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 + portName: + description: 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. + type: string + protocol: + description: The protocol this BackendService uses to communicate with backends. + Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending + on the chosen load balancer or Traffic Director configuration. Refer to + the documentation for the load balancers or for Traffic Director for more + information. Must be set to GRPC when the backend service is referenced + by a URL map that is bound to target gRPC proxy. + enum: + - GRPC + - HTTP + - HTTP2 + - HTTPS + - SSL + - TCP + - UDP + type: string + region: + description: '[Output Only] URL of the region where the regional backend + service resides. This field is not applicable to global backend services. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + securityPolicy: + description: '[Output Only] The resource URL for the security policy associated + with this backend service.' + type: string + securitySettings: + $ref: '#/components/schemas/SecuritySettings' + description: 'This field specifies the security policy that applies to this + backend service. This field is applicable to either: - A regional backend + service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme + set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme + set to INTERNAL_SELF_MANAGED. ' + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sessionAffinity: + description: 'Type of session affinity to use. The default is NONE. For + a detailed description of session affinity options, see: [Session affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + 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.' + enum: + - CLIENT_IP + - CLIENT_IP_NO_DESTINATION + - CLIENT_IP_PORT_PROTO + - CLIENT_IP_PROTO + - GENERATED_COOKIE + - HEADER_FIELD + - HTTP_COOKIE + - NONE + type: string + subsetting: + $ref: '#/components/schemas/Subsetting' + timeoutSec: + description: 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. Instead, use maxStreamDuration. + format: int32 + type: integer + type: object + BackendServiceAggregatedList: + description: Contains a list of BackendServicesScopedList. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/BackendServicesScopedList' + description: Name of the scope containing this set of BackendServices. + description: A list of BackendServicesScopedList resources. + type: object + kind: + default: compute#backendServiceAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + BackendServiceCdnPolicy: + description: Message containing Cloud CDN configuration for a backend service. + properties: + bypassCacheOnRequestHeaders: + description: Bypass the cache when the specified request headers are matched + - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. + The cache is bypassed for all cdnPolicy.cacheMode settings. + items: + $ref: '#/components/schemas/BackendServiceCdnPolicyBypassCacheOnRequestHeader' + type: array + cacheKeyPolicy: + $ref: '#/components/schemas/CacheKeyPolicy' + description: The CacheKeyPolicy for this CdnPolicy. + cacheMode: + description: 'Specifies the cache setting for all responses from this backend. + The possible values are: USE_ORIGIN_HEADERS Requires the origin to set + valid caching headers to cache content. Responses without these headers + will not be cached at Google''s edge, and will require a full trip to + the origin on every request, potentially impacting performance and increasing + load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring + any "private", "no-store" or "no-cache" directives in Cache-Control response + headers. Warning: this may result in Cloud CDN caching private, per-user + (user identifiable) content. CACHE_ALL_STATIC Automatically cache static + content, including common image formats, media (video and audio), and + web assets (JavaScript and CSS). Requests and responses that are marked + as uncacheable, as well as dynamic content (including HTML), will not + be cached.' + enum: + - CACHE_ALL_STATIC + - FORCE_CACHE_ALL + - INVALID_CACHE_MODE + - USE_ORIGIN_HEADERS + type: string + clientTtl: + description: Specifies a separate client (e.g. browser client) maximum TTL. + This is used to clamp the max-age (or Expires) value sent to the client. + With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used + for the response max-age directive, along with a "public" directive. For + cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age + from the origin (if specified), or else sets the response max-age directive + to the lesser of the client_ttl and default_ttl, and also ensures a "public" + cache-control directive is present. If a client TTL is not specified, + a default value (1 hour) will be used. The maximum allowed value is 31,622,400s + (1 year). + format: int32 + type: integer + defaultTtl: + description: Specifies the default TTL for cached content served by this + origin for responses that do not have an existing valid TTL (max-age or + s-max-age). Setting a TTL of "0" means "always revalidate". The value + of defaultTTL cannot be set to a value greater than that of maxTTL, but + can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL + will overwrite the TTL set in all responses. The maximum allowed value + is 31,622,400s (1 year), noting that infrequently accessed objects may + be evicted from the cache before the defined TTL. + format: int32 + type: integer + maxTtl: + description: Specifies the maximum allowed TTL for cached content served + by this origin. Cache directives that attempt to set a max-age or s-maxage + higher than this, or an Expires header more than maxTTL seconds in the + future will be capped at the value of maxTTL, as if it were the value + of an s-maxage Cache-Control directive. Headers sent to the client will + not be modified. Setting a TTL of "0" means "always revalidate". The maximum + allowed value is 31,622,400s (1 year), noting that infrequently accessed + objects may be evicted from the cache before the defined TTL. + format: int32 + type: integer + negativeCaching: + description: 'Negative caching allows per-status code TTLs to be set, in + order to apply fine-grained caching for common errors or redirects. This + can reduce the load on your origin and improve end-user experience by + reducing response latency. When the cache mode is set to CACHE_ALL_STATIC + or USE_ORIGIN_HEADERS, negative caching applies to responses with the + specified response code that lack any Cache-Control, Expires, or Pragma: + no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative + caching applies to all responses with the specified response code, and + override any caching headers. By default, Cloud CDN will apply the following + default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 + (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable + For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected + Request), 501 (Not Implemented): 60s. These defaults can be overridden + in negative_caching_policy.' + type: boolean + negativeCachingPolicy: + description: Sets a cache TTL for the specified HTTP status code. negative_caching + must be enabled to configure negative_caching_policy. Omitting the policy + and leaving negative_caching enabled will use Cloud CDN's default cache + TTLs. Note that when specifying an explicit negative_caching_policy, you + should take care to specify a cache TTL for all response codes that you + wish to cache. Cloud CDN will not apply any default negative caching when + a policy exists. + items: + $ref: '#/components/schemas/BackendServiceCdnPolicyNegativeCachingPolicy' + type: array + requestCoalescing: + description: If true then Cloud CDN will combine multiple concurrent cache + fill requests into a small number of requests to the origin. + type: boolean + serveWhileStale: + description: Serve existing content from the cache (if available) when revalidating + content with the origin, or when an error is encountered when refreshing + the cache. This setting defines the default "max-stale" duration for any + cached responses that do not specify a max-stale directive. Stale responses + that exceed the TTL configured here will not be served. The default limit + (max-stale) is 86400s (1 day), which will allow stale content to be served + up to this limit beyond the max-age (or s-max-age) of a cached response. + The maximum allowed value is 604800 (1 week). Set this to zero (0) to + disable serve-while-stale. + format: int32 + type: integer + signedUrlCacheMaxAgeSec: + description: 'Maximum number of seconds the response to a signed URL request + will be considered fresh. After this time period, the response will be + revalidated before being served. Defaults to 1hr (3600s). When serving + responses to signed URL requests, Cloud CDN will internally behave as + though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" + header, regardless of any existing Cache-Control header. The actual headers + served in responses will not be altered.' + format: int64 + type: string + signedUrlKeyNames: + description: '[Output Only] Names of the keys for signing request URLs.' + items: + type: string + type: array + type: object + BackendServiceCdnPolicyBypassCacheOnRequestHeader: + description: Bypass the cache when the specified request headers are present, + e.g. Pragma or Authorization headers. Values are case insensitive. The presence + of such a header overrides the cache_mode setting. + properties: + headerName: + description: The header field name to match on when bypassing cache. Values + are case-insensitive. + type: string + type: object + BackendServiceCdnPolicyNegativeCachingPolicy: + description: Specify CDN TTLs for response error codes. + properties: + code: + description: The HTTP status code to define a TTL against. Only HTTP status + codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can + be specified as values, and you cannot specify a status code more than + once. + format: int32 + type: integer + ttl: + description: The TTL (in seconds) for which to cache responses with the + corresponding status code. The maximum allowed value is 1800s (30 minutes), + noting that infrequently accessed objects may be evicted from the cache + before the defined TTL. + format: int32 + type: integer + type: object + BackendServiceFailoverPolicy: + description: 'For load balancers that have configurable failover: [Internal + TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external TCP/UDP Load Balancing](/network/networklb-failover-overview). + On failover or failback, this field indicates whether connection draining + will be honored. Google Cloud has a fixed connection draining timeout of 10 + minutes. A setting of true terminates existing TCP connections to the active + pool during failover and failback, immediately draining traffic. A setting + of false allows existing TCP connections to persist, even on VMs no longer + in the active pool, for up to the duration of the connection draining timeout + (10 minutes).' + properties: + disableConnectionDrainOnFailover: + description: This can be set to true only if the protocol is TCP. The default + is false. + type: boolean + dropTrafficIfUnhealthy: + description: 'If set to true, connections to the load balancer are dropped + when all primary and all backup backend VMs are unhealthy.If set to false, + connections are distributed among all primary VMs when all primary and + all backup backend VMs are unhealthy. For load balancers that have configurable + failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external TCP/UDP Load Balancing](/network/networklb-failover-overview). + The default is false.' + type: boolean + failoverRatio: + description: 'The value of the field must be in the range [0, 1]. If the + value is 0, the load balancer performs a failover when the number of healthy + primary VMs equals zero. For all other values, the load balancer performs + a failover when the total number of healthy primary VMs is less than this + ratio. For load balancers that have configurable failover: [Internal TCP/UDP + Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external TCP/UDP Load Balancing](/network/networklb-failover-overview).' + format: float + type: number + type: object + BackendServiceGroupHealth: + properties: + annotations: + additionalProperties: + type: string + description: Metadata defined as annotations on the network endpoint group. + type: object + healthStatus: + description: Health state of the backend instances or endpoints in requested + instance or network endpoint group, determined based on configured health + checks. + items: + $ref: '#/components/schemas/HealthStatus' + type: array + kind: + default: compute#backendServiceGroupHealth + description: '[Output Only] Type of resource. Always compute#backendServiceGroupHealth + for the health of backend services.' + type: string + type: object + BackendServiceIAP: + description: Identity-Aware Proxy + properties: + enabled: + description: Whether the serving infrastructure will authenticate and authorize + all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret + fields must be non-empty. + type: boolean + oauth2ClientId: + description: OAuth2 client ID to use for the authentication flow. + type: string + oauth2ClientSecret: + description: OAuth2 client secret to use for the authentication flow. For + security reasons, this value cannot be retrieved via the API. Instead, + the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 + field. @InputOnly + type: string + oauth2ClientSecretSha256: + description: '[Output Only] SHA256 hash value for the field oauth2_client_secret + above.' + type: string + type: object + BackendServiceList: + description: Contains a list of BackendService resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of BackendService resources. + items: + $ref: '#/components/schemas/BackendService' + type: array + kind: + default: compute#backendServiceList + description: '[Output Only] Type of resource. Always compute#backendServiceList + for lists of backend services.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + BackendServiceLogConfig: + description: The available logging options for the load balancer traffic served + by this backend service. + properties: + enable: + description: This field denotes whether to enable logging for the load balancer + traffic served by this backend service. + type: boolean + sampleRate: + description: This field can only be specified if logging is enabled for + this backend service. The value of the field must be in [0, 1]. This configures + the sampling rate of requests to the load balancer where 1.0 means all + logged requests are reported and 0.0 means no logged requests are reported. + The default value is 1.0. + format: float + type: number + type: object + BackendServiceReference: + properties: + backendService: + type: string + type: object + BackendServicesScopedList: + properties: + backendServices: + description: A list of BackendServices contained in this scope. + items: + $ref: '#/components/schemas/BackendService' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + BfdPacket: + properties: + authenticationPresent: + description: The Authentication Present bit of the BFD packet. This is specified + in section 4.1 of RFC5880 + type: boolean + controlPlaneIndependent: + description: The Control Plane Independent bit of the BFD packet. This is + specified in section 4.1 of RFC5880 + type: boolean + demand: + description: The demand bit of the BFD packet. This is specified in section + 4.1 of RFC5880 + type: boolean + diagnostic: + description: The diagnostic code specifies the local system's reason for + the last change in session state. This allows remote systems to determine + the reason that the previous session failed, for example. These diagnostic + codes are specified in section 4.1 of RFC5880 + enum: + - ADMINISTRATIVELY_DOWN + - CONCATENATED_PATH_DOWN + - CONTROL_DETECTION_TIME_EXPIRED + - DIAGNOSTIC_UNSPECIFIED + - ECHO_FUNCTION_FAILED + - FORWARDING_PLANE_RESET + - NEIGHBOR_SIGNALED_SESSION_DOWN + - NO_DIAGNOSTIC + - PATH_DOWN + - REVERSE_CONCATENATED_PATH_DOWN + type: string + final: + description: The Final bit of the BFD packet. This is specified in section + 4.1 of RFC5880 + type: boolean + length: + description: The length of the BFD Control packet in bytes. This is specified + in section 4.1 of RFC5880 + format: uint32 + type: integer + minEchoRxIntervalMs: + description: The Required Min Echo RX Interval value in the BFD packet. + This is specified in section 4.1 of RFC5880 + format: uint32 + type: integer + minRxIntervalMs: + description: The Required Min RX Interval value in the BFD packet. This + is specified in section 4.1 of RFC5880 + format: uint32 + type: integer + minTxIntervalMs: + description: The Desired Min TX Interval value in the BFD packet. This is + specified in section 4.1 of RFC5880 + format: uint32 + type: integer + multiplier: + description: The detection time multiplier of the BFD packet. This is specified + in section 4.1 of RFC5880 + format: uint32 + type: integer + multipoint: + description: The multipoint bit of the BFD packet. This is specified in + section 4.1 of RFC5880 + type: boolean + myDiscriminator: + description: The My Discriminator value in the BFD packet. This is specified + in section 4.1 of RFC5880 + format: uint32 + type: integer + poll: + description: The Poll bit of the BFD packet. This is specified in section + 4.1 of RFC5880 + type: boolean + state: + description: The current BFD session state as seen by the transmitting system. + These states are specified in section 4.1 of RFC5880 + enum: + - ADMIN_DOWN + - DOWN + - INIT + - STATE_UNSPECIFIED + - UP + type: string + version: + description: The version number of the BFD protocol, as specified in section + 4.1 of RFC5880. + format: uint32 + type: integer + yourDiscriminator: + description: The Your Discriminator value in the BFD packet. This is specified + in section 4.1 of RFC5880 + format: uint32 + type: integer + type: object + BfdStatus: + description: 'Next free: 15' + properties: + bfdSessionInitializationMode: + description: The BFD session initialization mode for this BGP peer. If set + to ACTIVE, the Cloud Router will initiate the BFD session for this BGP + peer. If set to PASSIVE, the Cloud Router will wait for the peer router + to initiate the BFD session for this BGP peer. If set to DISABLED, BFD + is disabled for this BGP peer. + enum: + - ACTIVE + - DISABLED + - PASSIVE + type: string + configUpdateTimestampMicros: + description: Unix timestamp of the most recent config update. + format: int64 + type: string + controlPacketCounts: + $ref: '#/components/schemas/BfdStatusPacketCounts' + description: Control packet counts for the current BFD session. + controlPacketIntervals: + description: Inter-packet time interval statistics for control packets. + items: + $ref: '#/components/schemas/PacketIntervals' + type: array + localDiagnostic: + description: The diagnostic code specifies the local system's reason for + the last change in session state. This allows remote systems to determine + the reason that the previous session failed, for example. These diagnostic + codes are specified in section 4.1 of RFC5880 + enum: + - ADMINISTRATIVELY_DOWN + - CONCATENATED_PATH_DOWN + - CONTROL_DETECTION_TIME_EXPIRED + - DIAGNOSTIC_UNSPECIFIED + - ECHO_FUNCTION_FAILED + - FORWARDING_PLANE_RESET + - NEIGHBOR_SIGNALED_SESSION_DOWN + - NO_DIAGNOSTIC + - PATH_DOWN + - REVERSE_CONCATENATED_PATH_DOWN + type: string + localState: + description: The current BFD session state as seen by the transmitting system. + These states are specified in section 4.1 of RFC5880 + enum: + - ADMIN_DOWN + - DOWN + - INIT + - STATE_UNSPECIFIED + - UP + type: string + negotiatedLocalControlTxIntervalMs: + description: Negotiated transmit interval for control packets. + format: uint32 + type: integer + rxPacket: + $ref: '#/components/schemas/BfdPacket' + description: The most recent Rx control packet for this BFD session. + txPacket: + $ref: '#/components/schemas/BfdPacket' + description: The most recent Tx control packet for this BFD session. + uptimeMs: + description: Session uptime in milliseconds. Value will be 0 if session + is not up. + format: int64 + type: string + type: object + BfdStatusPacketCounts: + properties: + numRx: + description: Number of packets received since the beginning of the current + BFD session. + format: uint32 + type: integer + numRxRejected: + description: Number of packets received that were rejected because of errors + since the beginning of the current BFD session. + format: uint32 + type: integer + numRxSuccessful: + description: Number of packets received that were successfully processed + since the beginning of the current BFD session. + format: uint32 + type: integer + numTx: + description: Number of packets transmitted since the beginning of the current + BFD session. + format: uint32 + type: integer + type: object + Binding: + description: Associates `members` with a `role`. + properties: + bindingId: + description: This is deprecated and has no effect. Do not use. + type: string + condition: + $ref: '#/components/schemas/Expr' + description: The condition that is associated with this binding. If the + condition evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding does + not apply to the current request. However, a different role binding might + grant the same role to one or more of the members in this binding. To + learn which resources support conditions in their IAM policies, see the + [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + members: + description: 'Specifies the identities requesting access for a Cloud Platform + resource. `members` can have the following values: * `allUsers`: A special + identifier that represents anyone who is on the internet; with or without + a Google account. * `allAuthenticatedUsers`: A special identifier that + represents anyone who is authenticated with a Google account or a service + account. * `user:{emailid}`: An email address that represents a specific + Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: + An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. + * `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a user that has + been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and the + recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a service account + that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` + and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google group + that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. + If the group is recovered, this value reverts to `group:{emailid}` and + the recovered group retains the role in the binding. * `domain:{domain}`: + The G Suite domain (primary) that represents all the users of that domain. + For example, `google.com` or `example.com`. ' + items: + type: string + type: array + role: + description: Role that is assigned to `members`. For example, `roles/viewer`, + `roles/editor`, or `roles/owner`. + type: string + type: object + BulkInsertInstanceResource: + description: A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert + . This resource is not persisted anywhere, it is used only for processing + the requests. + properties: + count: + description: The maximum number of instances to create. + format: int64 + type: string + instanceProperties: + $ref: '#/components/schemas/InstanceProperties' + description: The instance properties defining the VM instances to be created. + Required if sourceInstanceTemplate is not provided. + locationPolicy: + $ref: '#/components/schemas/LocationPolicy' + description: Policy for chosing target zone. + minCount: + description: The minimum number of instances to create. If no min_count + is specified then count is used as the default value. If min_count instances + cannot be created, then no instances will be created and instances already + created will be deleted. + format: int64 + type: string + namePattern: + description: 'The string pattern used for the names of the VMs. Either name_pattern + or per_instance_properties must be set. The pattern must contain one continuous + sequence of placeholder hash characters (#) with each character corresponding + to one digit of the generated instance name. Example: a name_pattern of + inst-#### generates instance names such as inst-0001 and inst-0002. If + existing instances in the same project and zone have names that match + the name pattern then the generated instance numbers start after the biggest + existing number. For example, if there exists an instance with name inst-0050, + then instance names generated using the pattern inst-#### begin with inst-0051. + The name pattern placeholder #...# can contain up to 18 characters.' + type: string + perInstanceProperties: + additionalProperties: + $ref: '#/components/schemas/BulkInsertInstanceResourcePerInstanceProperties' + description: Per-instance properties to be set on individual instances. + Keys of this map specify requested instance names. Can be empty if name_pattern + is used. + type: object + sourceInstanceTemplate: + description: 'Specifies the instance template from which to create instances. + You may combine sourceInstanceTemplate with instanceProperties to override + specific values from an existing instance template. Bulk API follows the + semantics of JSON Merge Patch described by RFC 7396. It can be a full + or partial URL. For example, the following are all valid URLs to an instance + template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate + - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate + This field is optional.' + type: string + type: object + BulkInsertInstanceResourcePerInstanceProperties: + description: Per-instance properties to be set on individual instances. To be + extended in the future. + properties: + name: + description: This field is only temporary. It will be removed. Do not use + it. + type: string + type: object + CacheInvalidationRule: + properties: + host: + description: If set, this invalidation rule will only apply to requests + with a Host header matching host. + type: string + path: + type: string + type: object + CacheKeyPolicy: + description: Message containing what to include in the cache key for a request + for Cloud CDN. + properties: + includeHost: + description: If true, requests to different hosts will be cached separately. + type: boolean + includeProtocol: + description: If true, http and https requests will be cached separately. + type: boolean + includeQueryString: + description: If true, include query string parameters in the cache key according + to query_string_whitelist and query_string_blacklist. If neither is set, + the entire query string will be included. If false, the query string will + be excluded from the cache key entirely. + type: boolean + queryStringBlacklist: + description: Names of query string parameters to exclude in cache keys. + All other parameters will be included. Either specify query_string_whitelist + or query_string_blacklist, not both. '&' and '=' will be percent encoded + and not treated as delimiters. + items: + type: string + type: array + queryStringWhitelist: + description: Names of query string parameters to include in cache keys. + All other parameters will be excluded. Either specify query_string_whitelist + or query_string_blacklist, not both. '&' and '=' will be percent encoded + and not treated as delimiters. + items: + type: string + type: array + type: object + CircuitBreakers: + description: Settings controlling the volume of requests, connections and retries + to this backend service. + properties: + maxConnections: + description: 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. + format: int32 + type: integer + maxPendingRequests: + description: 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. + format: int32 + type: integer + maxRequests: + description: The maximum number of parallel requests that allowed to the + backend service. If not specified, there is no limit. + format: int32 + type: integer + maxRequestsPerConnection: + description: 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. + format: int32 + type: integer + maxRetries: + description: 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. + format: int32 + type: integer + type: object + Commitment: + description: Represents a regional Commitment resource. Creating a commitment + resource means that you are purchasing a committed use contract with an explicit + start and end time. You can create commitments based on vCPUs and memory usage + and receive discounted rates. For full details, read Signing Up for Committed + Use Discounts. + properties: + category: + description: The category of the commitment. Category MACHINE specifies + commitments composed of machine resources such as VCPU or MEMORY, listed + in resources. Category LICENSE specifies commitments composed of software + licenses, listed in licenseResources. Note that only MACHINE commitments + should have a Type specified. + enum: + - CATEGORY_UNSPECIFIED + - LICENSE + - MACHINE + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + endTimestamp: + description: '[Output Only] Commitment end time in RFC3339 text format.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#commitment + description: '[Output Only] Type of the resource. Always compute#commitment + for commitments.' + type: string + licenseResource: + $ref: '#/components/schemas/LicenseResourceCommitment' + description: The license specification required as part of a license commitment. + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + plan: + description: The plan for this commitment, which determines duration and + discount rate. The currently supported plans are TWELVE_MONTH (1 year), + and THIRTY_SIX_MONTH (3 years). + enum: + - INVALID + - THIRTY_SIX_MONTH + - TWELVE_MONTH + type: string + region: + description: '[Output Only] URL of the region where this commitment may + be used.' + type: string + reservations: + description: List of reservations in this commitment. + items: + $ref: '#/components/schemas/Reservation' + type: array + resources: + description: A list of commitment amounts for particular resources. Note + that VCPU and MEMORY resource commitments must occur together. + items: + $ref: '#/components/schemas/ResourceCommitment' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + startTimestamp: + description: '[Output Only] Commitment start time in RFC3339 text format.' + type: string + status: + description: '[Output Only] Status of the commitment with regards to eventual + expiration (each commitment has an end date defined). One of the following + values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.' + enum: + - ACTIVE + - CREATING + - EXPIRED + - NOT_YET_ACTIVE + type: string + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the + status.' + type: string + type: + description: The type of commitment, which affects the discount rate and + the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that + will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED + specifies a commitment that will only apply to accelerator optimized machines. + enum: + - ACCELERATOR_OPTIMIZED + - COMPUTE_OPTIMIZED + - GENERAL_PURPOSE + - GENERAL_PURPOSE_E2 + - GENERAL_PURPOSE_N2 + - GENERAL_PURPOSE_N2D + - MEMORY_OPTIMIZED + - TYPE_UNSPECIFIED + type: string + type: object + CommitmentAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/CommitmentsScopedList' + description: '[Output Only] Name of the scope containing this set of commitments.' + description: A list of CommitmentsScopedList resources. + type: object + kind: + default: compute#commitmentAggregatedList + description: '[Output Only] Type of resource. Always compute#commitmentAggregatedList + for aggregated lists of commitments.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + CommitmentList: + description: Contains a list of Commitment resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Commitment resources. + items: + $ref: '#/components/schemas/Commitment' + type: array + kind: + default: compute#commitmentList + description: '[Output Only] Type of resource. Always compute#commitmentList + for lists of commitments.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + CommitmentsScopedList: + properties: + commitments: + description: '[Output Only] A list of commitments contained in this scope.' + items: + $ref: '#/components/schemas/Commitment' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of commitments 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Condition: + description: This is deprecated and has no effect. Do not use. + properties: + iam: + description: This is deprecated and has no effect. Do not use. + enum: + - APPROVER + - ATTRIBUTION + - AUTHORITY + - CREDENTIALS_TYPE + - CREDS_ASSERTION + - JUSTIFICATION_TYPE + - NO_ATTR + - SECURITY_REALM + type: string + op: + description: This is deprecated and has no effect. Do not use. + enum: + - DISCHARGED + - EQUALS + - IN + - NOT_EQUALS + - NOT_IN + - NO_OP + type: string + svc: + description: This is deprecated and has no effect. Do not use. + type: string + sys: + description: This is deprecated and has no effect. Do not use. + enum: + - IP + - NAME + - NO_ATTR + - REGION + - SERVICE + type: string + values: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + type: object + ConfidentialInstanceConfig: + description: A set of Confidential Instance options. + properties: + enableConfidentialCompute: + description: Defines whether the instance should have confidential compute + enabled. + type: boolean + type: object + ConnectionDraining: + description: Message containing connection draining configuration. + properties: + drainingTimeoutSec: + description: Configures a duration timeout for existing requests on a removed + backend instance. For supported load balancers and protocols, as described + in Enabling connection draining. + format: int32 + type: integer + type: object + ConsistentHashLoadBalancerSettings: + description: This message defines settings for a consistent hash style load + balancer. + properties: + httpCookie: + $ref: '#/components/schemas/ConsistentHashLoadBalancerSettingsHttpCookie' + description: Hash is based on HTTP Cookie. This field describes a HTTP cookie + that will be used as the hash key for the consistent hash load balancer. + If the cookie is not present, it will be generated. This field is applicable + if the sessionAffinity is set to HTTP_COOKIE. + httpHeaderName: + description: The hash based on the value of the specified header field. + This field is applicable if the sessionAffinity is set to HEADER_FIELD. + type: string + minimumRingSize: + description: The minimum number of virtual nodes to use for the hash ring. + Defaults to 1024. Larger ring sizes result in more granular load distributions. + If the number of hosts in the load balancing pool is larger than the ring + size, each host will be assigned a single virtual node. + format: int64 + type: string + type: object + ConsistentHashLoadBalancerSettingsHttpCookie: + description: The information about the HTTP Cookie on which the hash function + is based for load balancing policies that use a consistent hash. + properties: + name: + description: Name of the cookie. + type: string + path: + description: Path to set for the cookie. + type: string + ttl: + $ref: '#/components/schemas/Duration' + description: Lifetime of the cookie. + type: object + CorsPolicy: + description: The specification for allowing client side cross-origin requests. + Please see W3C Recommendation for Cross Origin Resource Sharing + properties: + allowCredentials: + description: In response to a preflight request, setting this to true indicates + that the actual request can include user credentials. This translates + to the Access-Control-Allow-Credentials header. Default is false. + type: boolean + allowHeaders: + description: Specifies the content for the Access-Control-Allow-Headers + header. + items: + type: string + type: array + allowMethods: + description: Specifies the content for the Access-Control-Allow-Methods + header. + items: + type: string + type: array + allowOriginRegexes: + description: Specifies the regualar expression patterns that match allowed + origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax + An origin is allowed if it matches either an item in allowOrigins or an + item in allowOriginRegexes. + items: + type: string + type: array + allowOrigins: + description: Specifies the list of origins that will be allowed to do CORS + requests. An origin is allowed if it matches either an item in allowOrigins + or an item in allowOriginRegexes. + items: + type: string + type: array + disabled: + description: If true, specifies the CORS policy is disabled. The default + value of false, which indicates that the CORS policy is in effect. + type: boolean + exposeHeaders: + description: Specifies the content for the Access-Control-Expose-Headers + header. + items: + type: string + type: array + maxAge: + description: Specifies how long results of a preflight request can be cached + in seconds. This translates to the Access-Control-Max-Age header. + format: int32 + type: integer + type: object + CustomerEncryptionKey: + properties: + kmsKeyName: + description: 'The name of the encryption key that is stored in Google Cloud + KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + key_region/cryptoKeys/key ' + type: string + kmsKeyServiceAccount: + description: 'The service account being used for the encryption request + for the given KMS key. If absent, the Compute Engine default service account + is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ ' + type: string + rawKey: + description: 'Specifies a 256-bit customer-supplied encryption key, encoded + in RFC 4648 base64 to either encrypt or decrypt this resource. You can + provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": + "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" ' + type: string + rsaEncryptedKey: + description: '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 ' + type: string + sha256: + description: '[Output only] The RFC 4648 base64 encoded SHA-256 hash of + the customer-supplied encryption key that protects this resource.' + type: string + type: object + CustomerEncryptionKeyProtectedDisk: + properties: + diskEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: Decrypts data associated with the disk with a customer-supplied + encryption key. + source: + description: 'Specifies a valid partial or full URL to an existing Persistent + Disk resource. This field is only applicable for persistent disks. For + example: "source": "/compute/v1/projects/project_id/zones/zone/disks/ + disk_name ' + type: string + type: object + DeprecationStatus: + description: Deprecation status for a public resource. + properties: + deleted: + description: An optional RFC3339 timestamp on or after which the state of + this resource is intended to change to DELETED. This is only informational + and the status will not change unless the client explicitly changes it. + type: string + deprecated: + description: An optional RFC3339 timestamp on or after which the state of + this resource is intended to change to DEPRECATED. This is only informational + and the status will not change unless the client explicitly changes it. + type: string + obsolete: + description: An optional RFC3339 timestamp on or after which the state of + this resource is intended to change to OBSOLETE. This is only informational + and the status will not change unless the client explicitly changes it. + type: string + replacement: + description: The URL of the suggested replacement for a deprecated resource. + The suggested replacement resource must be the same kind of resource as + the deprecated resource. + type: string + state: + description: The deprecation state of this resource. This can be ACTIVE, + DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end + of life date for an image, can use ACTIVE. Operations which create a new + resource using a DEPRECATED resource will return successfully, but with + a warning indicating the deprecated resource and recommending its replacement. + Operations which use OBSOLETE or DELETED resources will be rejected and + result in an error. + enum: + - ACTIVE + - DELETED + - DEPRECATED + - OBSOLETE + type: string + type: object + Disk: + description: 'Represents a Persistent Disk resource. Google Compute Engine has + two Disk resources: * [Zonal](/compute/docs/reference/rest/v1/disks) * [Regional](/compute/docs/reference/rest/v1/regionDisks) + Persistent disks are required for running your VM instances. Create both boot + and non-boot (data) persistent disks. For more information, read Persistent + Disks. For more storage options, read Storage options. The disks resource + represents a zonal persistent disk. For more information, read Zonal persistent + disks. The regionDisks resource represents a regional persistent disk. For + more information, read Regional resources.' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + diskEncryptionKey: + $ref: '#/components/schemas/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.' + 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. + items: + $ref: '#/components/schemas/GuestOsFeature' + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#disk + description: '[Output Only] Type of the resource. Always compute#disk for + disks.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this disk, which + is essentially a hash of the labels set used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve a disk. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this disk. These can be later modified by + the setLabels method. + type: object + lastAttachTimestamp: + description: '[Output Only] Last attach timestamp in RFC3339 text format.' + type: string + lastDetachTimestamp: + description: '[Output Only] Last detach timestamp in RFC3339 text format.' + type: string + licenseCodes: + description: Integer license codes indicating which licenses are attached + to this disk. + items: + format: int64 + type: string + type: array + licenses: + description: A list of publicly visible licenses. Reserved for Google's + use. + items: + type: string + type: array + locationHint: + description: An opaque location hint used to place the disk close to other + resources. This field is for use by internal tools that use the public + API. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + options: + description: Internal use only. + type: string + physicalBlockSizeBytes: + description: Physical block size of the persistent disk, in bytes. If not + present in a request, a default value is used. The currently supported + size is 4096, other sizes may be added in the future. If an unsupported + value is requested, the error message will list the supported values for + the caller's project. + format: int64 + type: string + provisionedIops: + description: Indicates how many IOPS to provision for the disk. This sets + the number of I/O operations per second that the disk can handle. Values + must be between 10,000 and 120,000. For more details, see the Extreme + persistent disk documentation. + format: int64 + type: string + region: + description: '[Output Only] URL of the region where the disk resides. Only + applicable for regional resources. You must specify this field as part + of the HTTP request URL. It is not settable as a field in the request + body.' + type: string + replicaZones: + description: URLs of the zones where the disk should be replicated to. Only + applicable for regional resources. + items: + type: string + type: array + resourcePolicies: + description: Resource policies applied to this disk for automatic snapshot + creations. + items: + type: string + type: array + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this + resource.' + type: string + sizeGb: + description: Size, in GB, of the persistent disk. You can specify this field + when creating a persistent disk using the sourceImage, sourceSnapshot, + or sourceDisk parameter, or specify it alone to create an empty persistent + disk. If you specify this field along with a source, the value of sizeGb + must not be less than the size of the source. Acceptable values are 1 + to 65536, inclusive. + format: int64 + type: string + sourceDisk: + description: 'The source disk used to create this disk. You can provide + this as a partial or full URL to the resource. For example, the following + are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region + /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk + - zones/zone/disks/disk - regions/region/disks/disk ' + type: string + sourceDiskId: + description: '[Output Only] The unique ID of the disk used to create this + disk. This value identifies the exact disk that was used to create this + persistent disk. For example, if you created the persistent disk from + a disk that was later deleted and recreated under the same name, the source + disk ID would identify the exact version of the disk that was used.' + type: string + sourceImage: + description: 'The source image used to create this disk. If the source image + is deleted, this field will not be set. To create a disk with one of the + public operating system images, specify the image by its family name. + For example, specify family/debian-9 to use the latest Debian 9 image: + projects/debian-cloud/global/images/family/debian-9 Alternatively, use + a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD + To create a disk with a custom image that you created, specify the image + name in the following format: global/images/my-custom-image You can also + specify a custom image by its image family, which returns the latest version + of the image in that family. Replace the image name with family/family-name: + global/images/family/my-image-family ' + type: string + sourceImageEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption key. + sourceImageId: + description: '[Output Only] The ID value of the image used to create this + disk. This value identifies the exact image that was used to create this + persistent disk. For example, if you created the persistent disk from + an image that was later deleted and recreated under the same name, the + source image ID would identify the exact version of the image that was + used.' + type: string + sourceSnapshot: + description: 'The source snapshot used to create this disk. You can provide + this as a partial or full URL to the resource. For example, the following + are valid values: - https://www.googleapis.com/compute/v1/projects/project + /global/snapshots/snapshot - projects/project/global/snapshots/snapshot + - global/snapshots/snapshot ' + type: string + sourceSnapshotEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source snapshot. + Required if the source snapshot is protected by a customer-supplied encryption + key. + sourceSnapshotId: + description: '[Output Only] The unique ID of the snapshot used to create + this disk. This value identifies the exact snapshot that was used to create + this persistent disk. For example, if you created the persistent disk + from a snapshot that was later deleted and recreated under the same name, + the source snapshot ID would identify the exact version of the snapshot + that was used.' + type: string + sourceStorageObject: + description: The full Google Cloud Storage URI where the disk image is stored. + This file must be a gzip-compressed tarball whose name ends in .tar.gz + or virtual machine disk whose name ends in vmdk. Valid URIs may start + with gs:// or https://storage.googleapis.com/. This flag is not optimized + for creating multiple disks from a source storage object. To create many + disks from a source storage object, use gcloud compute images import instead. + type: string + status: + description: '[Output Only] The status of disk creation. - CREATING: Disk + is provisioning. - RESTORING: Source data is being copied into the disk. + - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: + Disk is deleting. ' + enum: + - CREATING + - DELETING + - FAILED + - READY + - RESTORING + type: string + type: + description: 'URL of the disk type resource describing which disk type to + use to create the disk. Provide this when creating the disk. For example: + projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.' + type: string + users: + description: '[Output Only] Links to the users of the disk (attached instances) + in form: projects/project/zones/zone/instances/instance' + items: + type: string + type: array + zone: + description: '[Output Only] URL of the zone where the disk resides. You + must specify this field as part of the HTTP request URL. It is not settable + as a field in the request body.' + type: string + type: object + DiskAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/DisksScopedList' + description: '[Output Only] Name of the scope containing this set of disks.' + description: A list of DisksScopedList resources. + type: object + kind: + default: compute#diskAggregatedList + description: '[Output Only] Type of resource. Always compute#diskAggregatedList + for aggregated lists of persistent disks.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DiskInstantiationConfig: + description: A specification of the desired way to instantiate a disk in the + instance template when its created from a source instance. + properties: + autoDelete: + description: Specifies whether the disk will be auto-deleted when the instance + is deleted (but not when the disk is detached from the instance). + type: boolean + customImage: + description: The custom source image to be used to restore this disk when + instantiating this instance template. + type: string + deviceName: + description: Specifies the device name of the disk to which the configurations + apply to. + type: string + instantiateFrom: + description: 'Specifies whether to include the disk and what image to use. + Possible values are: - source-image: to use the same image that was used + to create the source instance''s corresponding disk. Applicable to the + boot disk and additional read-write disks. - source-image-family: to use + the same image family that was used to create the source instance''s corresponding + disk. Applicable to the boot disk and additional read-write disks. - custom-image: + to use a user-provided image url for disk creation. Applicable to the + boot disk and additional read-write disks. - attach-read-only: to attach + a read-only disk. Applicable to read-only disks. - do-not-include: to + exclude a disk from the template. Applicable to additional read-write + disks, local SSDs, and read-only disks. ' + enum: + - ATTACH_READ_ONLY + - BLANK + - CUSTOM_IMAGE + - DEFAULT + - DO_NOT_INCLUDE + - SOURCE_IMAGE + - SOURCE_IMAGE_FAMILY + type: string + type: object + DiskList: + description: A list of Disk resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Disk resources. + items: + $ref: '#/components/schemas/Disk' + type: array + kind: + default: compute#diskList + description: '[Output Only] Type of resource. Always compute#diskList for + lists of disks.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DiskMoveRequest: + properties: + destinationZone: + description: 'The URL of the destination zone to move the disk. This can + be a full or partial URL. For example, the following are all valid URLs + to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + - projects/project/zones/zone - zones/zone ' + type: string + targetDisk: + description: 'The URL of the target disk to move. This can be a full or + partial URL. For example, the following are all valid URLs to a disk: + - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk + - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ' + type: string + type: object + DiskType: + description: 'Represents a Disk Type resource. Google Compute Engine has two + Disk Type resources: * [Regional](/compute/docs/reference/rest/v1/regionDiskTypes) + * [Zonal](/compute/docs/reference/rest/v1/diskTypes) You can choose from a + variety of disk types based on your needs. For more information, read Storage + options. The diskTypes resource represents disk types for a zonal persistent + disk. For more information, read Zonal persistent disks. The regionDiskTypes + resource represents disk types for a regional persistent disk. For more information, + read Regional persistent disks.' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + defaultDiskSizeGb: + description: '[Output Only] Server-defined default disk size in GB.' + format: int64 + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + disk type.' + description: + description: '[Output Only] An optional description of this resource.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#diskType + description: '[Output Only] Type of the resource. Always compute#diskType + for disk types.' + type: string + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + region: + description: '[Output Only] URL of the region where the disk type resides. + Only applicable for regional resources. You must specify this field as + part of the HTTP request URL. It is not settable as a field in the request + body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + validDiskSize: + description: '[Output Only] An optional textual description of the valid + disk size, such as "10GB-10TB".' + type: string + zone: + description: '[Output Only] URL of the zone where the disk type resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + type: object + DiskTypeAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/DiskTypesScopedList' + description: '[Output Only] Name of the scope containing this set of disk + types.' + description: A list of DiskTypesScopedList resources. + type: object + kind: + default: compute#diskTypeAggregatedList + description: '[Output Only] Type of resource. Always compute#diskTypeAggregatedList.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DiskTypeList: + description: Contains a list of disk types. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of DiskType resources. + items: + $ref: '#/components/schemas/DiskType' + type: array + kind: + default: compute#diskTypeList + description: '[Output Only] Type of resource. Always compute#diskTypeList + for disk types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DiskTypesScopedList: + properties: + diskTypes: + description: '[Output Only] A list of disk types contained in this scope.' + items: + $ref: '#/components/schemas/DiskType' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of disk types 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DisksAddResourcePoliciesRequest: + properties: + resourcePolicies: + description: Full or relative path to the resource policy to be added to + this disk. You can only specify one resource policy. + items: + type: string + type: array + type: object + DisksRemoveResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be removed from this disk. + items: + type: string + type: array + type: object + DisksResizeRequest: + properties: + sizeGb: + description: The new size of the persistent disk, which is specified in + GB. + format: int64 + type: string + type: object + DisksScopedList: + properties: + disks: + description: '[Output Only] A list of disks contained in this scope.' + items: + $ref: '#/components/schemas/Disk' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of disks 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + DisplayDevice: + description: A set of Display Device options + properties: + enableDisplay: + description: Defines whether the instance has Display enabled. + type: boolean + type: object + DistributionPolicy: + properties: + targetShape: + description: The distribution shape to which the group converges either + proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). + enum: + - ANY + - BALANCED + - EVEN + type: string + zones: + description: Zones where the regional managed instance group will create + and manage its instances. + items: + $ref: '#/components/schemas/DistributionPolicyZoneConfiguration' + type: array + type: object + DistributionPolicyZoneConfiguration: + properties: + zone: + description: The URL of the zone. The zone must exist in the region where + the managed instance group is located. + type: string + type: object + Duration: + description: 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. + properties: + nanos: + description: 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. + format: int32 + type: integer + seconds: + description: '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' + format: int64 + type: string + type: object + ExchangedPeeringRoute: + properties: + destRange: + description: The destination range of the route. + type: string + imported: + description: True if the peering route has been imported from a peer. The + actual import happens if the field networkPeering.importCustomRoutes is + true for this network, and networkPeering.exportCustomRoutes is true for + the peer network, and the import does not result in a route conflict. + type: boolean + nextHopRegion: + description: The region of peering route next hop, only applies to dynamic + routes. + type: string + priority: + description: The priority of the peering route. + format: uint32 + type: integer + type: + description: The type of the peering route. + enum: + - DYNAMIC_PEERING_ROUTE + - STATIC_PEERING_ROUTE + - SUBNET_PEERING_ROUTE + type: string + type: object + ExchangedPeeringRoutesList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of ExchangedPeeringRoute resources. + items: + $ref: '#/components/schemas/ExchangedPeeringRoute' + type: array + kind: + default: compute#exchangedPeeringRoutesList + description: '[Output Only] Type of resource. Always compute#exchangedPeeringRoutesList + for exchanged peering routes 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + 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.' + 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 + ExternalVpnGateway: + description: Represents an external VPN gateway. External VPN gateway is the + on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects + to your Google Cloud VPN gateway. To create a highly available VPN from Google + Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, + you must create a external VPN gateway resource with information about the + other gateway. For more information about using external VPN gateways, see + Creating an HA VPN gateway and tunnel pair to a peer VPN. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + interfaces: + description: A list of interfaces for this external VPN gateway. If your + peer-side gateway is an on-premises gateway and non-AWS cloud providers' + gateway, at most two interfaces can be provided for an external VPN gateway. + If your peer side is an AWS virtual private gateway, four interfaces should + be provided for an external VPN gateway. + items: + $ref: '#/components/schemas/ExternalVpnGatewayInterface' + type: array + kind: + default: compute#externalVpnGateway + description: '[Output Only] Type of the resource. Always compute#externalVpnGateway + for externalVpnGateways.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this ExternalVpnGateway, + which is essentially a hash of the labels set used for optimistic locking. + The fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve an ExternalVpnGateway. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels for this resource. These can only be added or modified + by the setLabels method. Each label key/value pair must comply with RFC1035. + Label values may be empty. + type: object + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + redundancyType: + description: Indicates the user-supplied redundancy type of this external + VPN gateway. + enum: + - FOUR_IPS_REDUNDANCY + - SINGLE_IP_INTERNALLY_REDUNDANT + - TWO_IPS_REDUNDANCY + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + ExternalVpnGatewayInterface: + description: The interface for the external VPN gateway. + properties: + id: + description: 'The numeric ID of this interface. The allowed input values + for this id for different redundancy types of external VPN gateway: - + SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY + - 0, 1, 2, 3 ' + format: uint32 + type: integer + ipAddress: + description: IP address of the interface in the external VPN gateway. Only + IPv4 is supported. This IP address can be either from your on-premise + gateway or another Cloud provider's VPN gateway, it cannot be an IP address + from Google Compute Engine. + type: string + type: object + ExternalVpnGatewayList: + description: Response to the list request, and contains a list of externalVpnGateways. + properties: + etag: + type: string + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of ExternalVpnGateway resources. + items: + $ref: '#/components/schemas/ExternalVpnGateway' + type: array + kind: + default: compute#externalVpnGatewayList + description: '[Output Only] Type of resource. Always compute#externalVpnGatewayList + for lists of externalVpnGateways.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + FileContentBuffer: + properties: + content: + description: The raw content in the secure keys file. + format: byte + type: string + fileType: + description: The file type of source file. + enum: + - BIN + - UNDEFINED + - X509 + type: string + type: object + Firewall: + description: Represents a Firewall Rule resource. Firewall rules allow or deny + ingress traffic to, and egress traffic from your instances. For more information, + read Firewall rules. + properties: + allowed: + description: The list of ALLOW rules specified by this firewall. Each rule + specifies a protocol and port-range tuple that describes a permitted connection. + items: + properties: + IPProtocol: + description: The IP protocol to which this rule applies. The protocol + type is required when creating a firewall rule. This value can either + be one of the following well known protocol strings (tcp, udp, icmp, + esp, ah, ipip, sctp) or the IP protocol number. + type: string + ports: + description: 'An optional list of ports to which this rule applies. + This field is only applicable for the UDP or TCP protocol. Each + entry must be either an integer or a range. If not specified, this + rule applies to connections through any port. Example inputs include: + ["22"], ["80","443"], and ["12345-12349"].' + items: + type: string + type: array + type: object + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + denied: + description: The list of DENY rules specified by this firewall. Each rule + specifies a protocol and port-range tuple that describes a denied connection. + items: + properties: + IPProtocol: + description: The IP protocol to which this rule applies. The protocol + type is required when creating a firewall rule. This value can either + be one of the following well known protocol strings (tcp, udp, icmp, + esp, ah, ipip, sctp) or the IP protocol number. + type: string + ports: + description: 'An optional list of ports to which this rule applies. + This field is only applicable for the UDP or TCP protocol. Each + entry must be either an integer or a range. If not specified, this + rule applies to connections through any port. Example inputs include: + ["22"], ["80","443"], and ["12345-12349"].' + items: + type: string + type: array + type: object + type: array + description: + description: An optional description of this resource. Provide this field + when you create the resource. + type: string + destinationRanges: + description: If destination ranges are specified, the firewall rule applies + only to traffic that has destination IP address in these ranges. These + ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported. + items: + type: string + type: array + direction: + description: Direction of traffic to which this firewall applies, either + `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, + you cannot specify the destinationRanges field, and for `EGRESS` traffic, + you cannot specify the sourceRanges or sourceTags fields. + enum: + - EGRESS + - INGRESS + type: string + disabled: + description: Denotes whether the firewall rule is disabled. When set to + true, the firewall rule is not enforced and the network behaves as if + it did not exist. If this is unspecified, the firewall rule will be enabled. + type: boolean + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#firewall + description: '[Output Only] Type of the resource. Always compute#firewall + for firewall rules.' + type: string + logConfig: + $ref: '#/components/schemas/FirewallLogConfig' + description: This field denotes the logging options for a particular firewall + rule. If logging is enabled, logs will be exported to Cloud Logging. + name: + description: 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])?`. The first character must be a + lowercase letter, and all following characters (except for the last character) + must be a dash, lowercase letter, or digit. The last character must be + a lowercase letter or digit. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: 'URL of the network resource for this firewall rule. If not + specified when creating a firewall rule, the default network is used: + global/networks/default If you choose to specify this field, you can specify + the network as a full or partial URL. For example, the following are all + valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network + - projects/myproject/global/networks/my-network - global/networks/default ' + type: string + priority: + description: Priority for this rule. This is an integer between `0` and + `65535`, both inclusive. The default value is `1000`. Relative priorities + determine which rule takes effect if multiple rules apply. Lower values + indicate higher priority. For example, a rule with priority `0` has higher + precedence than a rule with priority `1`. DENY rules take precedence over + ALLOW rules if they have equal priority. Note that VPC networks have implied + rules with a priority of `65535`. To avoid conflicts with the implied + rules, use a priority number less than `65535`. + format: int32 + type: integer + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sourceRanges: + description: If source ranges are specified, the firewall rule applies only + to traffic that has a source IP address in these ranges. These ranges + must be expressed in CIDR format. One or both of sourceRanges and sourceTags + may be set. If both fields are set, the rule applies to traffic that has + a source IP address within sourceRanges OR a source IP from a resource + with a matching tag listed in the sourceTags field. The connection does + not need to match both fields for the rule to apply. Both IPv4 and IPv6 + are supported. + items: + type: string + type: array + sourceServiceAccounts: + description: If source service accounts are specified, the firewall rules + apply only to traffic originating from an instance with a service account + in this list. Source service accounts cannot be used to control traffic + to an instance's external IP address because service accounts are associated + with an instance, not an IP address. sourceRanges can be set at the same + time as sourceServiceAccounts. If both are set, the firewall applies to + traffic that has a source IP address within the sourceRanges OR a source + IP that belongs to an instance with service account listed in sourceServiceAccount. + The connection does not need to match both fields for the firewall to + apply. sourceServiceAccounts cannot be used at the same time as sourceTags + or targetTags. + items: + type: string + type: array + sourceTags: + description: If source tags are specified, the firewall rule applies only + to traffic with source IPs that match the primary network interfaces of + VM instances that have the tag and are in the same VPC network. Source + tags cannot be used to control traffic to an instance's external IP address, + it only applies to traffic between instances in the same virtual network. + Because tags are associated with instances, not IP addresses. One or both + of sourceRanges and sourceTags may be set. If both fields are set, the + firewall applies to traffic that has a source IP address within sourceRanges + OR a source IP from a resource with a matching tag listed in the sourceTags + field. The connection does not need to match both fields for the firewall + to apply. + items: + type: string + type: array + targetServiceAccounts: + description: A list of service accounts indicating sets of instances located + in the network that may make network connections as specified in allowed[]. + targetServiceAccounts cannot be used at the same time as targetTags or + sourceTags. If neither targetServiceAccounts nor targetTags are specified, + the firewall rule applies to all instances on the specified network. + items: + type: string + type: array + targetTags: + description: A list of tags that controls which instances the firewall rule + applies to. If targetTags are specified, then the firewall rule applies + only to instances in the VPC network that have one of those tags. If no + targetTags are specified, the firewall rule applies to all instances on + the specified network. + items: + type: string + type: array + type: object + FirewallList: + description: Contains a list of firewalls. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Firewall resources. + items: + $ref: '#/components/schemas/Firewall' + type: array + kind: + default: compute#firewallList + description: '[Output Only] Type of resource. Always compute#firewallList + for lists of firewalls.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + FirewallLogConfig: + description: The available logging options for a firewall rule. + properties: + enable: + description: This field denotes whether to enable logging for a particular + firewall rule. + type: boolean + metadata: + description: This field can only be specified for a particular firewall + rule if logging is enabled for that rule. This field denotes whether to + include or exclude metadata for firewall logs. + enum: + - EXCLUDE_ALL_METADATA + - INCLUDE_ALL_METADATA + type: string + type: object + FirewallPoliciesListAssociationsResponse: + properties: + associations: + description: A list of associations. + items: + $ref: '#/components/schemas/FirewallPolicyAssociation' + type: array + kind: + default: compute#firewallPoliciesListAssociationsResponse + description: '[Output Only] Type of firewallPolicy associations. Always + compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations.' + type: string + type: object + FirewallPolicy: + description: Represents a Firewall Policy resource. + properties: + associations: + description: A list of associations that belong to this firewall policy. + items: + $ref: '#/components/schemas/FirewallPolicyAssociation' + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + displayName: + 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 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 + fingerprint: + description: Specifies a fingerprint for this resource, which is essentially + a hash of the metadata's contents and used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update metadata. You must always provide an + up-to-date fingerprint hash in order to update or change metadata, otherwise + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make get() request to the firewall policy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#firewallPolicy + description: '[Output only] Type of the resource. Always compute#firewallPolicyfor + firewall policies' + type: string + name: + description: '[Output Only] Name of the resource. It is a numeric ID allocated + by GCP which uniquely identifies the Firewall Policy.' + type: string + parent: + description: '[Output Only] The parent of the firewall policy.' + type: string + ruleTupleCount: + description: '[Output Only] Total count of all firewall policy rule tuples. + A firewall policy can not exceed a set number of tuples.' + format: int32 + type: integer + rules: + description: A list of rules that belong to this policy. There must always + be a default rule (rule with priority 2147483647 and match "*"). If no + rules are provided when creating a firewall policy, a default rule with + action "allow" will be added. + items: + $ref: '#/components/schemas/FirewallPolicyRule' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + selfLinkWithId: + description: '[Output Only] Server-defined URL for this resource with the + resource id.' + type: string + shortName: + description: User-provided name of the Organization firewall plicy. The + name should be unique in the organization in which the firewall policy + is created. 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 + type: object + FirewallPolicyAssociation: + properties: + attachmentTarget: + description: The target that the firewall policy is attached to. + type: string + displayName: + description: '[Output Only] Deprecated, please use short name instead. The + display name of the firewall policy of the association.' + type: string + firewallPolicyId: + description: '[Output Only] The firewall policy ID of the association.' + type: string + name: + description: The name for an association. + type: string + shortName: + description: '[Output Only] The short name of the firewall policy of the + association.' + type: string + type: object + FirewallPolicyList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of FirewallPolicy resources. + items: + $ref: '#/components/schemas/FirewallPolicy' + type: array + kind: + default: compute#firewallPolicyList + description: '[Output Only] Type of resource. Always compute#firewallPolicyList + for listsof FirewallPolicies' + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + FirewallPolicyRule: + description: Represents a rule that describes one or more match conditions along + with the action to be taken when traffic matches this condition (allow or + deny). + properties: + action: + description: The Action to perform when the client connection triggers the + rule. Can currently be either "allow" or "deny()" where valid values for + status are 403, 404, and 502. + type: string + description: + description: An optional description for this resource. + type: string + direction: + description: The direction in which this rule applies. + enum: + - EGRESS + - INGRESS + type: string + disabled: + description: Denotes whether the firewall policy rule is disabled. When + set to true, the firewall policy rule is not enforced and traffic behaves + as if it did not exist. If this is unspecified, the firewall policy rule + will be enabled. + type: boolean + enableLogging: + description: 'Denotes whether to enable logging for a particular rule. If + logging is enabled, logs will be exported to the configured export destination + in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you + cannot enable logging on "goto_next" rules.' + type: boolean + kind: + default: compute#firewallPolicyRule + description: '[Output only] Type of the resource. Always compute#firewallPolicyRule + for firewall policy rules' + type: string + match: + $ref: '#/components/schemas/FirewallPolicyRuleMatcher' + description: A match condition that incoming traffic is evaluated against. + If it evaluates to true, the corresponding 'action' is enforced. + priority: + description: An integer indicating the priority of a rule in the list. The + priority must be a positive value between 0 and 2147483647. Rules are + evaluated from highest to lowest priority where 0 is the highest priority + and 2147483647 is the lowest prority. + format: int32 + type: integer + ruleTupleCount: + description: '[Output Only] Calculation of the complexity of a single firewall + policy rule.' + format: int32 + type: integer + targetResources: + description: A list of network resource URLs to which this rule applies. + This field allows you to control which network's VMs get this rule. If + this field is left blank, all VMs within the organization will receive + the rule. + items: + type: string + type: array + targetServiceAccounts: + description: A list of service accounts indicating the sets of instances + that are applied with this rule. + items: + type: string + type: array + type: object + FirewallPolicyRuleMatcher: + description: Represents a match condition that incoming traffic is evaluated + against. Exactly one field must be specified. + properties: + destIpRanges: + description: CIDR IP address range. Maximum number of destination CIDR IP + ranges allowed is 5000. + items: + type: string + type: array + layer4Configs: + description: Pairs of IP protocols and ports that the rule should match. + items: + $ref: '#/components/schemas/FirewallPolicyRuleMatcherLayer4Config' + type: array + srcIpRanges: + description: CIDR IP address range. Maximum number of source CIDR IP ranges + allowed is 5000. + items: + type: string + type: array + type: object + FirewallPolicyRuleMatcherLayer4Config: + properties: + ipProtocol: + description: The IP protocol to which this rule applies. The protocol type + is required when creating a firewall rule. This value can either be one + of the following well known protocol strings (tcp, udp, icmp, esp, ah, + ipip, sctp), or the IP protocol number. + type: string + ports: + description: 'An optional list of ports to which this rule applies. This + field is only applicable for UDP or TCP protocol. Each entry must be either + an integer or a range. If not specified, this rule applies to connections + through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' + items: + type: string + type: array + type: object + FixedOrPercent: + description: Encapsulates numeric value that can be either absolute or relative. + properties: + calculated: + description: '[Output Only] Absolute value of VM instances calculated based + on the specific mode. - If the value is fixed, then the calculated value + is equal to the fixed value. - If the value is a percent, then the calculated + value is percent/100 * targetSize. For example, the calculated value of + a 80% of a managed instance group with 150 instances would be (80/100 + * 150) = 120 VM instances. If there is a remainder, the number is rounded. ' + format: int32 + type: integer + fixed: + description: Specifies a fixed number of VM instances. This must be a positive + integer. + format: int32 + type: integer + percent: + description: Specifies a percentage of instances between 0 to 100%, inclusive. + For example, specify 80 for 80%. + format: int32 + type: integer + type: object + ForwardingRule: + description: 'Represents a Forwarding Rule resource. Forwarding rule resources + in Google Cloud can be either regional or global in scope: * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules) + * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules) + A forwarding rule and its corresponding IP address represent the frontend + configuration of a Google Cloud Platform load balancer. Forwarding rules can + also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). + For more information, read Forwarding rule concepts and Using protocol forwarding.' + properties: + IPAddress: + description: 'IP address that this forwarding rule serves. When a client + sends traffic to this IP address, the forwarding rule directs the traffic + to the target that you specify in the forwarding rule. If you don''t specify + a reserved IP address, an ephemeral IP address is assigned. Methods for + specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full + URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region + /addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name + - regions/region/addresses/address-name - global/addresses/address-name + - address-name The loadBalancingScheme and the forwarding rule''s target + determine the type of IP address that you can use. For detailed information, + see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). + Must be set to `0.0.0.0` when the target is targetGrpcProxy that has validateForProxyless + field set to true. For Private Service Connect forwarding rules that forward + traffic to Google APIs, IP address must be provided.' + type: string + IPProtocol: + description: The IP protocol to which this rule applies. For protocol forwarding, + valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid + IP protocols are different for different load balancing products as described + in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). + enum: + - AH + - ESP + - ICMP + - SCTP + - TCP + - UDP + type: string + allPorts: + description: This field is used along with the backend_service field for + Internal TCP/UDP Load Balancing or Network Load Balancing, or with the + target field for internal and external TargetInstance. You can only use + one of ports and port_range, or allPorts. The three are mutually exclusive. + For TCP, UDP and SCTP traffic, packets addressed to any ports will be + forwarded to the target or backendService. + type: boolean + allowGlobalAccess: + description: This field is used along with the backend_service field for + internal load balancing or with the target field for internal TargetInstance. + If the field is set to TRUE, clients can access ILB from all regions. + Otherwise only allows access from clients in the same region as the internal + load balancer. + type: boolean + backendService: + description: Identifies the backend service to which the forwarding rule + sends traffic. Required for Internal TCP/UDP Load Balancing and Network + Load Balancing; must be omitted for all other load balancer types. + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a ForwardingRule. Include the fingerprint in + patch request to ensure that you do not overwrite changes that were applied + from another concurrent request. To see the latest fingerprint, make a + get() request to retrieve a ForwardingRule. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + ipVersion: + description: The IP Version that will be used by this forwarding rule. Valid + options are IPV4 or IPV6. This can only be specified for an external global + forwarding rule. + enum: + - IPV4 + - IPV6 + - UNSPECIFIED_VERSION + type: string + isMirroringCollector: + description: Indicates whether or not this load balancer can be used as + a collector for packet mirroring. To prevent mirroring loops, instances + behind this load balancer will not have their traffic mirrored even if + a PacketMirroring rule applies to them. This can only be set to true for + load balancers that have their loadBalancingScheme set to INTERNAL. + type: boolean + kind: + default: compute#forwardingRule + description: '[Output Only] Type of the resource. Always compute#forwardingRule + for Forwarding Rule resources.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this resource, + which is essentially a hash of the labels set used for optimistic locking. + The fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve a ForwardingRule. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels for this resource. These can only be added or modified + by the setLabels method. Each label key/value pair must comply with RFC1035. + Label values may be empty. + type: object + loadBalancingScheme: + description: Specifies the forwarding rule type. For more information about + forwarding rules, refer to Forwarding rule concepts. + enum: + - EXTERNAL + - INTERNAL + - INTERNAL_MANAGED + - INTERNAL_SELF_MANAGED + - INVALID + type: string + metadataFilters: + description: Opaque filter criteria used by load balancer to restrict routing + configuration to a limited set of xDS compliant clients. In their xDS + requests to load balancer, xDS clients present node metadata. When there + is a match, the relevant configuration is made available to those proxies. + Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced + by the ForwardingRule are not visible to those proxies. For each metadataFilter + in this list, if its filterMatchCriteria is set to MATCH_ANY, at least + one of the filterLabels must match the corresponding label provided in + the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all + of its filterLabels must match with corresponding labels provided in the + metadata. If multiple metadataFilters are specified, all of them need + to be satisfied in order to be considered a match. metadataFilters specified + here will be applifed before those specified in the UrlMap that this ForwardingRule + references. metadataFilters only applies to Loadbalancers that have their + loadBalancingScheme set to INTERNAL_SELF_MANAGED. + items: + $ref: '#/components/schemas/MetadataFilter' + type: array + name: + description: 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. For Private Service Connect forwarding rules that forward traffic + to Google APIs, the forwarding rule name must be a 1-20 characters string + with lowercase letters and numbers and must start with a letter. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: This field is not used for external load balancing. For Internal + TCP/UDP Load Balancing, this field identifies the network that the load + balanced IP should belong to for this Forwarding Rule. If this field is + not specified, the default network will be used. For Private Service Connect + forwarding rules that forward traffic to Google APIs, a network must be + provided. + type: string + networkTier: + description: 'This signifies the networking tier used for configuring this + load balancer and can only take the following values: PREMIUM, STANDARD. + For regional ForwardingRule, the valid values are PREMIUM and STANDARD. + For GlobalForwardingRule, the valid value is PREMIUM. If this field is + not specified, it is assumed to be PREMIUM. If IPAddress is specified, + this value must be equal to the networkTier of the Address.' + enum: + - PREMIUM + - STANDARD + type: string + portRange: + description: 'This field can be used only if: - Load balancing scheme is + one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol + is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified + range will be forwarded to target or backend_service. You can only use + one of ports, port_range, or allPorts. The three are mutually exclusive. + Forwarding rules with the same [IPAddress, IPProtocol] pair must have + disjoint ports. Some types of forwarding target have constraints on the + acceptable ports. For more information, see [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications). + @pattern: \\d+(?:-\\d+)?' + type: string + ports: + description: 'The ports field is only supported when the forwarding rule + references a backend_service directly. Only packets addressed to the [specified + list of ports]((https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications)) + are forwarded to backends. You can only use one of ports and port_range, + or allPorts. The three are mutually exclusive. You can specify a list + of up to five ports, which can be non-contiguous. Forwarding rules with + the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: + \\d+(?:-\\d+)?' + items: + type: string + type: array + pscConnectionId: + description: '[Output Only] The PSC connection id of the PSC Forwarding + Rule.' + format: uint64 + type: string + pscConnectionStatus: + enum: + - ACCEPTED + - CLOSED + - PENDING + - REJECTED + - STATUS_UNSPECIFIED + type: string + region: + description: '[Output Only] URL of the region where the regional forwarding + rule resides. This field is not applicable to global forwarding rules. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + serviceDirectoryRegistrations: + description: Service Directory resources to register this forwarding rule + with. Currently, only supports a single Service Directory resource. It + is only supported for internal load balancing. + items: + $ref: '#/components/schemas/ForwardingRuleServiceDirectoryRegistration' + type: array + serviceLabel: + description: An optional prefix to the service name for this Forwarding + Rule. If specified, the prefix is the first label of the fully qualified + service name. The label must be 1-63 characters long, and comply with + RFC1035. Specifically, the label 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. This field is only used for internal load balancing. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + serviceName: + description: '[Output Only] The internal fully qualified service name for + this Forwarding Rule. This field is only used for internal load balancing.' + type: string + subnetwork: + description: This field identifies the subnetwork that the load balanced + IP should belong to for this Forwarding Rule, used in internal load balancing + and network load balancing with IPv6. If the network specified is in auto + subnet mode, this field is optional. However, a subnetwork must be specified + if the network is in custom subnet mode or when creating external forwarding + rule with IPv6. + type: string + target: + type: string + type: object + ForwardingRuleAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/ForwardingRulesScopedList' + description: Name of the scope containing this set of addresses. + description: A list of ForwardingRulesScopedList resources. + type: object + kind: + default: compute#forwardingRuleAggregatedList + description: '[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList + for lists of forwarding rules.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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. + 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: '#/components/schemas/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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ForwardingRuleReference: + properties: + forwardingRule: + type: string + type: object + ForwardingRuleServiceDirectoryRegistration: + description: Describes the auto-registration of the Forwarding Rule to Service + Directory. The region and project of the Service Directory resource generated + from this registration will be the same as this Forwarding Rule. + properties: + namespace: + description: Service Directory namespace to register the forwarding rule + under. + type: string + service: + description: Service Directory service to register the forwarding rule under. + type: string + serviceDirectoryRegion: + description: '[Optional] Service Directory region to register this global + forwarding rule under. Default to "us-central1". Only used for PSC for + Google APIs. All PSC for Google APIs Forwarding Rules on the same network + should use the same Service Directory region.' + type: string + type: object + ForwardingRulesScopedList: + properties: + forwardingRules: + description: A list of forwarding rules contained in this scope. + items: + $ref: '#/components/schemas/ForwardingRule' + type: array + warning: + description: Informational warning which replaces the list of forwarding + rules 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + GRPCHealthCheck: + properties: + grpcServiceName: + description: 'The gRPC service name for the health check. This field is + optional. The value of grpc_service_name has the following meanings by + convention: - Empty service_name means the overall status of all services + at the backend. - Non-empty service_name means the health of that gRPC + service, as defined by the owner of the service. The grpc_service_name + can only be ASCII.' + type: string + port: + description: The port number for the health check request. Must be specified + if port_name and port_specification are not set or if port_specification + is USE_FIXED_PORT. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. The port_name should + conform to RFC1035. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, gRPC health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + type: object + GlobalNetworkEndpointGroupsAttachEndpointsRequest: + properties: + networkEndpoints: + description: The list of network endpoints to be attached. + items: + $ref: '#/components/schemas/NetworkEndpoint' + type: array + type: object + GlobalNetworkEndpointGroupsDetachEndpointsRequest: + properties: + networkEndpoints: + description: The list of network endpoints to be detached. + items: + $ref: '#/components/schemas/NetworkEndpoint' + type: array + type: object + GlobalOrganizationSetPolicyRequest: + properties: + bindings: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + format: byte + type: string + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the ''resource''. + The size of the policy is limited to a few 10s of KB. An empty policy + is in general a valid policy but certain services (like Projects) might + reject them.' + type: object + GlobalSetLabelsRequest: + properties: + labelFingerprint: + description: The fingerprint of the previous set of labels for this resource, + used to detect conflicts. The fingerprint is initially generated by Compute + Engine and changes after every request to modify or update labels. You + must always provide an up-to-date fingerprint hash when updating or changing + labels, otherwise the request will fail with error 412 conditionNotMet. + Make a get() request to the resource to get the latest fingerprint. + format: byte + type: string + labels: + additionalProperties: + type: string + description: 'A list of labels to apply for this resource. Each label key + & value must 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. For example, "webserver-frontend": + "images". A label value can also be empty (e.g. "my-label": "").' + type: object + type: object + GlobalSetPolicyRequest: + properties: + bindings: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + format: byte + type: string + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the ''resource''. + The size of the policy is limited to a few 10s of KB. An empty policy + is in general a valid policy but certain services (like Projects) might + reject them.' + type: object + GuestAttributes: + description: A guest attributes entry. + properties: + kind: + default: compute#guestAttributes + description: '[Output Only] Type of the resource. Always compute#guestAttributes + for guest attributes entry.' + type: string + queryPath: + description: The path to be queried. This can be the default namespace ('') + or a nested namespace ('\/') or a specified key ('\/\'). + type: string + queryValue: + $ref: '#/components/schemas/GuestAttributesValue' + description: '[Output Only] The value of the requested queried path.' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + variableKey: + description: The key to search for. + type: string + variableValue: + description: '[Output Only] The value found for the requested key.' + type: string + type: object + GuestAttributesEntry: + description: A guest attributes namespace/key/value entry. + properties: + key: + description: Key for the guest attribute entry. + type: string + namespace: + description: Namespace for the guest attribute entry. + type: string + value: + description: Value for the guest attribute entry. + type: string + type: object + GuestAttributesValue: + description: Array of guest attribute namespace/key/value tuples. + properties: + items: + items: + $ref: '#/components/schemas/GuestAttributesEntry' + type: array + type: object + GuestOsFeature: + description: Guest OS features. + properties: + type: + description: The ID of a supported feature. Read Enabling guest operating + system features to see a list of available options. + enum: + - FEATURE_TYPE_UNSPECIFIED + - GVNIC + - MULTI_IP_SUBNET + - SECURE_BOOT + - SEV_CAPABLE + - UEFI_COMPATIBLE + - VIRTIO_SCSI_MULTIQUEUE + - WINDOWS + type: string + type: object + HTTP2HealthCheck: + properties: + host: + description: The value of the host header in the HTTP/2 health check request. + If left empty (default value), the IP on behalf of which this health check + is performed will be used. + type: string + port: + description: The TCP port number for the health check request. The default + value is 443. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, HTTP2 health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + requestPath: + description: The request path of the HTTP/2 health check request. The default + value is /. + type: string + response: + description: The string to match anywhere in the first 1024 bytes of the + response body. If left empty (the default value), the status code determines + health. The response data can only be ASCII. + type: string + type: object + HTTPHealthCheck: + properties: + host: + description: The value of the host header in the HTTP health check request. + If left empty (default value), the IP on behalf of which this health check + is performed will be used. + type: string + port: + description: The TCP port number for the health check request. The default + value is 80. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, HTTP health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + requestPath: + description: The request path of the HTTP health check request. The default + value is /. + type: string + response: + description: The string to match anywhere in the first 1024 bytes of the + response body. If left empty (the default value), the status code determines + health. The response data can only be ASCII. + type: string + type: object + HTTPSHealthCheck: + properties: + host: + description: The value of the host header in the HTTPS health check request. + If left empty (default value), the IP on behalf of which this health check + is performed will be used. + type: string + port: + description: The TCP port number for the health check request. The default + value is 443. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, HTTPS health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + requestPath: + description: The request path of the HTTPS health check request. The default + value is /. + type: string + response: + description: The string to match anywhere in the first 1024 bytes of the + response body. If left empty (the default value), the status code determines + health. The response data can only be ASCII. + type: string + type: object + HealthCheck: + description: 'Represents a Health Check resource. Google Compute Engine has + two Health Check resources: * [Global](/compute/docs/reference/rest/v1/healthChecks) + * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) Internal + HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). + Traffic Director must use global health checks (`compute.v1.HealthChecks`). + Internal TCP/UDP load balancers can use either regional or global health checks + (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). External HTTP(S), + TCP proxy, and SSL proxy load balancers as well as managed instance group + auto-healing must use global health checks (`compute.v1.HealthChecks`). Backend + service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). + Target pool-based network load balancers must use legacy HTTP health checks + (`compute.v1.httpHealthChecks`). For more information, see Health checks overview.' + properties: + checkIntervalSec: + description: How often (in seconds) to send a health check. The default + value is 5 seconds. + format: int32 + type: integer + creationTimestamp: + description: '[Output Only] Creation timestamp in 3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + grpcHealthCheck: + $ref: '#/components/schemas/GRPCHealthCheck' + healthyThreshold: + description: A so-far unhealthy instance will be marked healthy after this + many consecutive successes. The default value is 2. + format: int32 + type: integer + http2HealthCheck: + $ref: '#/components/schemas/HTTP2HealthCheck' + httpHealthCheck: + $ref: '#/components/schemas/HTTPHealthCheck' + httpsHealthCheck: + $ref: '#/components/schemas/HTTPSHealthCheck' + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#healthCheck + description: Type of the resource. + type: string + logConfig: + $ref: '#/components/schemas/HealthCheckLogConfig' + description: Configure logging on this health check. + name: + description: 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. + For example, a name that is 1-63 characters long, matches the regular + expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. + This regular expression describes a name where the first character is + a lowercase letter, and all following characters are a dash, lowercase + letter, or digit, except the last character, which isn't a dash. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + region: + description: '[Output Only] Region where the health check resides. Not applicable + to global health checks.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sslHealthCheck: + $ref: '#/components/schemas/SSLHealthCheck' + tcpHealthCheck: + $ref: '#/components/schemas/TCPHealthCheck' + timeoutSec: + description: How long (in seconds) to wait before claiming failure. The + default value is 5 seconds. It is invalid for timeoutSec to have greater + value than checkIntervalSec. + format: int32 + type: integer + type: + description: Specifies the type of the healthCheck, either TCP, SSL, HTTP, + HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the + protocol-specific health check field must be specified, which must match + type field. + enum: + - GRPC + - HTTP + - HTTP2 + - HTTPS + - INVALID + - SSL + - TCP + type: string + unhealthyThreshold: + description: A so-far healthy instance will be marked unhealthy after this + many consecutive failures. The default value is 2. + format: int32 + type: integer + type: object + HealthCheckList: + description: Contains a list of HealthCheck resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of HealthCheck resources. + items: + $ref: '#/components/schemas/HealthCheck' + type: array + kind: + default: compute#healthCheckList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HealthCheckLogConfig: + description: Configuration of logging on a health check. If logging is enabled, + logs will be exported to Stackdriver. + properties: + enable: + description: Indicates whether or not to export logs. This is false by default, + which means no health check logging will be done. + type: boolean + type: object + HealthCheckReference: + description: '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 ' + properties: + healthCheck: + type: string + type: object + HealthCheckService: + description: Represents a Health-Check as a Service resource. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a HealthCheckService. An up-to-date fingerprint + must be provided in order to patch/update the HealthCheckService; Otherwise, + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the HealthCheckService. + format: byte + type: string + healthChecks: + description: A list of URLs to the HealthCheck resources. Must have at least + one HealthCheck, and not more than 10. HealthCheck resources must have + portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. + For regional HealthCheckService, the HealthCheck must be regional and + in the same region. For global HealthCheckService, HealthCheck must be + global. Mix of regional and global HealthChecks is not supported. Multiple + regional HealthChecks must belong to the same region. Regional HealthChecks + must belong to the same region as zones of NEGs. + items: + type: string + type: array + healthStatusAggregationPolicy: + description: Optional. Policy for how the results from multiple health checks + for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. + - NO_AGGREGATION. An EndpointHealth message is returned for each pair + in the health check service. - AND. If any health check of an endpoint + reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. + If all health checks report HEALTHY, the HealthState of the endpoint is + HEALTHY. . + enum: + - AND + - NO_AGGREGATION + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#healthCheckService + description: '[Output only] Type of the resource. Always compute#healthCheckServicefor + health check services.' + type: string + name: + description: Name of the resource. 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 + networkEndpointGroups: + description: A list of URLs to the NetworkEndpointGroup resources. Must + not have more than 100. For regional HealthCheckService, NEGs must be + in zones in the region of the HealthCheckService. + items: + type: string + type: array + notificationEndpoints: + description: A list of URLs to the NotificationEndpoint resources. Must + not have more than 10. A list of endpoints for receiving notifications + of change in health status. For regional HealthCheckService, NotificationEndpoint + must be regional and in the same region. For global HealthCheckService, + NotificationEndpoint must be global. + items: + type: string + type: array + region: + description: '[Output Only] URL of the region where the health check service + resides. This field is not applicable to global health check services. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + HealthCheckServiceReference: + description: '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 ' + properties: + healthCheckService: + type: string + type: object + HealthCheckServicesList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of HealthCheckService resources. + items: + $ref: '#/components/schemas/HealthCheckService' + type: array + kind: + default: compute#healthCheckServicesList + description: '[Output Only] Type of the resource. Always compute#healthCheckServicesList + for lists of HealthCheckServices.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HealthChecksAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/HealthChecksScopedList' + description: Name of the scope containing this set of HealthChecks. + description: A list of HealthChecksScopedList resources. + type: object + kind: + default: compute#healthChecksAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HealthChecksScopedList: + properties: + healthChecks: + description: A list of HealthChecks contained in this scope. + items: + $ref: '#/components/schemas/HealthCheck' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HealthStatus: + properties: + annotations: + additionalProperties: + type: string + description: Metadata defined as annotations for network endpoint. + type: object + forwardingRule: + description: URL of the forwarding rule associated with the health status + of the instance. + type: string + forwardingRuleIp: + description: A forwarding rule IP address assigned to this instance. + type: string + healthState: + description: Health state of the instance. + enum: + - HEALTHY + - UNHEALTHY + type: string + instance: + description: URL of the instance resource. + type: string + ipAddress: + description: For target pool based Network Load Balancing, it indicates + the forwarding rule's IP address assigned to this instance. For other + types of load balancing, the field indicates VM internal ip. + type: string + port: + description: The named port of the instance group, not necessarily the port + that is health-checked. + format: int32 + type: integer + weight: + type: string + weightError: + enum: + - INVALID_WEIGHT + - MISSING_WEIGHT + - UNAVAILABLE_WEIGHT + - WEIGHT_NONE + type: string + type: object + HealthStatusForNetworkEndpoint: + properties: + backendService: + $ref: '#/components/schemas/BackendServiceReference' + description: URL of the backend service associated with the health state + of the network endpoint. + forwardingRule: + $ref: '#/components/schemas/ForwardingRuleReference' + description: URL of the forwarding rule associated with the health state + of the network endpoint. + healthCheck: + $ref: '#/components/schemas/HealthCheckReference' + description: URL of the health check associated with the health state of + the network endpoint. + healthCheckService: + $ref: '#/components/schemas/HealthCheckServiceReference' + description: URL of the health check service associated with the health + state of the network endpoint. + healthState: + description: Health state of the network endpoint determined based on the + health checks configured. + enum: + - DRAINING + - HEALTHY + - UNHEALTHY + - UNKNOWN + type: string + type: object + HostRule: + description: UrlMaps A host-matching rule for a URL. If matched, will use the + named PathMatcher to select the BackendService. + properties: + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + hosts: + description: The list of host patterns to match. They must be valid hostnames + with optional port numbers in the format host:port. * matches any string + of ([a-z0-9-.]*). In that case, * must be the first character and must + be followed in the pattern by either - or .. * based matching is not supported + when the URL map is bound to target gRPC proxy that has validateForProxyless + field set to true. + items: + type: string + type: array + pathMatcher: + description: The name of the PathMatcher to use to match the path portion + of the URL if the hostRule matches the URL's host portion. + type: string + type: object + HttpFaultAbort: + description: Specification for how requests are aborted as part of fault injection. + properties: + httpStatus: + description: The HTTP status code used to abort the request. The value must + be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code + is mapped to HTTP status code according to this mapping table. HTTP status + 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently + not supported by Traffic Director. + format: uint32 + type: integer + percentage: + description: The percentage of traffic (connections/operations/requests) + which will be aborted as part of fault injection. The value must be between + 0.0 and 100.0 inclusive. + format: double + type: number + type: object + HttpFaultDelay: + description: Specifies the delay introduced by Loadbalancer before forwarding + the request to the backend service as part of fault injection. + properties: + fixedDelay: + $ref: '#/components/schemas/Duration' + description: Specifies the value of the fixed delay interval. + percentage: + description: The percentage of traffic (connections/operations/requests) + on which delay will be introduced as part of fault injection. The value + must be between 0.0 and 100.0 inclusive. + format: double + type: number + type: object + HttpFaultInjection: + description: The specification for fault injection introduced into traffic to + test the resiliency of clients to backend service failure. As part of fault + injection, when clients send requests to a backend service, delays can be + introduced by Loadbalancer on a percentage of requests before sending those + request to the backend service. Similarly requests from clients can be aborted + by the Loadbalancer for a percentage of requests. + properties: + abort: + $ref: '#/components/schemas/HttpFaultAbort' + description: The specification for how client requests are aborted as part + of fault injection. + delay: + $ref: '#/components/schemas/HttpFaultDelay' + description: The specification for how client requests are delayed as part + of fault injection, before being sent to a backend service. + type: object + HttpHeaderAction: + description: The request and response header transformations that take effect + before the request is passed along to the selected backendService. + properties: + requestHeadersToAdd: + description: Headers to add to a matching request prior to forwarding the + request to the backendService. + items: + $ref: '#/components/schemas/HttpHeaderOption' + type: array + requestHeadersToRemove: + description: A list of header names for headers that need to be removed + from the request prior to forwarding the request to the backendService. + items: + type: string + type: array + responseHeadersToAdd: + description: Headers to add the response prior to sending the response back + to the client. + items: + $ref: '#/components/schemas/HttpHeaderOption' + type: array + responseHeadersToRemove: + description: A list of header names for headers that need to be removed + from the response prior to sending the response back to the client. + items: + type: string + type: array + type: object + HttpHeaderMatch: + description: matchRule criteria for request header matches. + properties: + exactMatch: + description: The value should exactly match contents of exactMatch. Only + one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch + or rangeMatch must be set. + type: string + headerName: + description: 'The name of the HTTP header to match. For matching against + the HTTP request''s authority, use a headerMatch with the header name + ":authority". For matching a request''s method, use the headerName ":method". + When the URL map is bound to target gRPC proxy that has validateForProxyless + field set to true, only non-binary user-specified custom metadata and + the `content-type` header are supported. The following transport-level + headers cannot be used in header matching rules: `:authority`, `:method`, + `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, + `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, + `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.' + type: string + invertMatch: + description: If set to false, the headerMatch is considered a match if the + match criteria above are met. If set to true, the headerMatch is considered + a match if the match criteria above are NOT met. The default setting is + false. + type: boolean + prefixMatch: + description: The value of the header must start with the contents of prefixMatch. + Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch + or rangeMatch must be set. + type: string + presentMatch: + description: A header with the contents of headerName must exist. The match + takes place whether or not the request's header has a value. Only one + of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch + must be set. + type: boolean + rangeMatch: + $ref: '#/components/schemas/Int64RangeMatch' + description: The header value must be an integer and its value must be in + the range specified in rangeMatch. If the header does not contain an integer, + number or is empty, the match fails. For example for a range [-5, 0] - + -3 will match. - 0 will not match. - 0.25 will not match. - -3someString + will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, + presentMatch or rangeMatch must be set. Note that rangeMatch is not supported + for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. + regexMatch: + description: 'The value of the header must match the regular expression + specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax + For matching against a port specified in the HTTP request, use a headerMatch + with headerName set to PORT and a regular expression that satisfies the + RFC2616 Host header''s port specifier. Only one of exactMatch, prefixMatch, + suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note + that regexMatch only applies to Loadbalancers that have their loadBalancingScheme + set to INTERNAL_SELF_MANAGED.' + type: string + suffixMatch: + description: The value of the header must end with the contents of suffixMatch. + Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch + or rangeMatch must be set. + type: string + type: object + HttpHeaderOption: + description: Specification determining how headers are added to requests or + responses. + properties: + headerName: + description: The name of the header. + type: string + headerValue: + description: The value of the header to add. + type: string + replace: + description: If false, headerValue is appended to any values that already + exist for the header. If true, headerValue is set for the header, discarding + any values that were set for that header. The default value is false. + type: boolean + type: object + HttpHealthCheck: + description: Represents a legacy HTTP Health Check resource. Legacy HTTP health + checks are now only required by target pool-based network load balancers. + For all other load balancers, including backend service-based network load + balancers, and for managed instance group auto-healing, you must use modern + (non-legacy) health checks. For more information, see Health checks overview + . + properties: + checkIntervalSec: + description: How often (in seconds) to send a health check. The default + value is 5 seconds. + format: int32 + type: integer + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + healthyThreshold: + description: A so-far unhealthy instance will be marked healthy after this + many consecutive successes. The default value is 2. + format: int32 + type: integer + host: + description: The value of the host header in the HTTP health check request. + If left empty (default value), the public IP on behalf of which this health + check is performed will be used. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#httpHealthCheck + description: '[Output Only] Type of the resource. Always compute#httpHealthCheck + for HTTP health checks.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + port: + description: The TCP port number for the HTTP health check request. The + default value is 80. + format: int32 + type: integer + requestPath: + description: The request path of the HTTP health check request. The default + value is /. This field does not support query parameters. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + timeoutSec: + description: How long (in seconds) to wait before claiming failure. The + default value is 5 seconds. It is invalid for timeoutSec to have greater + value than checkIntervalSec. + format: int32 + type: integer + unhealthyThreshold: + description: A so-far healthy instance will be marked unhealthy after this + many consecutive failures. The default value is 2. + format: int32 + type: integer + type: object + HttpHealthCheckList: + description: Contains a list of HttpHealthCheck resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of HttpHealthCheck resources. + items: + $ref: '#/components/schemas/HttpHealthCheck' + type: array + kind: + default: compute#httpHealthCheckList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + HttpQueryParameterMatch: + description: HttpRouteRuleMatch criteria for a request's query parameter. + properties: + exactMatch: + description: The queryParameterMatch matches if the value of the parameter + exactly matches the contents of exactMatch. Only one of presentMatch, + exactMatch or regexMatch must be set. + type: string + name: + description: The name of the query parameter to match. The query parameter + must exist in the request, in the absence of which the request match fails. + type: string + presentMatch: + description: Specifies that the queryParameterMatch matches if the request + contains the query parameter, irrespective of whether the parameter has + a value or not. Only one of presentMatch, exactMatch or regexMatch must + be set. + type: boolean + regexMatch: + description: The queryParameterMatch matches if the value of the parameter + matches the regular expression specified by regexMatch. For the regular + expression grammar, please see github.com/google/re2/wiki/Syntax Only + one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch + only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. + type: string + type: object + HttpRedirectAction: + description: Specifies settings for an HTTP redirect. + properties: + hostRedirect: + description: The host that will be used in the redirect response instead + of the one that was supplied in the request. The value must be between + 1 and 255 characters. + type: string + httpsRedirect: + description: If set to true, the URL scheme in the redirected request is + set to https. If set to false, the URL scheme of the redirected request + will remain the same as that of the request. This must only be set for + UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy + is not permitted. The default is set to false. + type: boolean + pathRedirect: + description: The path that will be used in the redirect response instead + of the one that was supplied in the request. pathRedirect cannot be supplied + together with prefixRedirect. Supply one alone or neither. If neither + is supplied, the path of the original request will be used for the redirect. + The value must be between 1 and 1024 characters. + type: string + prefixRedirect: + description: The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, + retaining the remaining portion of the URL before redirecting the request. + prefixRedirect cannot be supplied together with pathRedirect. Supply one + alone or neither. If neither is supplied, the path of the original request + will be used for the redirect. The value must be between 1 and 1024 characters. + type: string + redirectResponseCode: + description: 'The HTTP Status code to use for this RedirectAction. Supported + values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and + corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which + corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In + this case, the request method will be retained. - PERMANENT_REDIRECT, + which corresponds to 308. In this case, the request method will be retained. ' + enum: + - FOUND + - MOVED_PERMANENTLY_DEFAULT + - PERMANENT_REDIRECT + - SEE_OTHER + - TEMPORARY_REDIRECT + type: string + stripQuery: + description: If set to true, any accompanying query portion of the original + URL is removed prior to redirecting the request. If set to false, the + query portion of the original URL is retained. The default is set to false. + type: boolean + type: object + HttpRetryPolicy: + description: The retry policy associates with HttpRouteRule + properties: + numRetries: + description: Specifies the allowed number retries. This number must be > + 0. If not specified, defaults to 1. + format: uint32 + type: integer + perTryTimeout: + $ref: '#/components/schemas/Duration' + description: Specifies a non-zero timeout per retry attempt. If not specified, + will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction + is not set, will use the largest timeout among all backend services associated + with the route. + retryConditions: + description: 'Specifies one or more conditions when this retry policy applies. + Valid values are: - 5xx: Retry will be attempted if the instance or endpoint + responds with any 5xx response code, or if the instance or endpoint does + not respond at all, example: disconnects, reset, read timeout, connection + failure, and refused streams. - gateway-error: Similar to 5xx, but only + applies to response codes 502, 503 or 504. - - connect-failure: A retry + will be attempted on failures connecting to the instance or endpoint, + for example due to connection timeouts. - retriable-4xx: A retry will + be attempted if the instance or endpoint responds with a retriable 4xx + response code. Currently the only retriable error supported is 409. - + refused-stream: A retry will be attempted if the instance or endpoint + resets the stream with a REFUSED_STREAM error code. This reset type indicates + that it is safe to retry. - cancelled: A retry will be attempted if the + gRPC status code in the response header is set to cancelled. - deadline-exceeded: + A retry will be attempted if the gRPC status code in the response header + is set to deadline-exceeded. - internal: A retry will be attempted if + the gRPC status code in the response header is set to internal. - resource-exhausted: + A retry will be attempted if the gRPC status code in the response header + is set to resource-exhausted. - unavailable: A retry will be attempted + if the gRPC status code in the response header is set to unavailable. ' + items: + type: string + type: array + type: object + HttpRouteAction: + properties: + corsPolicy: + $ref: '#/components/schemas/CorsPolicy' + description: The specification for allowing client side cross-origin requests. + Please see W3C Recommendation for Cross Origin Resource Sharing Not supported + when the URL map is bound to target gRPC proxy. + faultInjectionPolicy: + $ref: '#/components/schemas/HttpFaultInjection' + description: The specification for fault injection introduced into traffic + to test the resiliency of clients to backend service failure. As part + of fault injection, when clients send requests to a backend service, delays + can be introduced by Loadbalancer on a percentage of requests before sending + those request to the backend service. Similarly requests from clients + can be aborted by the Loadbalancer for a percentage of requests. For the + requests impacted by fault injection, timeout and retry_policy will be + ignored by clients that are configured with a fault_injection_policy. + maxStreamDuration: + $ref: '#/components/schemas/Duration' + description: Specifies the maximum duration (timeout) for streams on the + selected route. Unlike the timeout field where the timeout duration starts + from the time the request has been fully processed (i.e. end-of-stream), + the duration in this field is computed from the beginning of the stream + until the response has been completely processed, including all retries. + A stream that does not complete in this duration is closed. If not specified, + will use the largest maxStreamDuration among all backend services associated + with the route. This field is only allowed if the Url map is used with + backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED. + requestMirrorPolicy: + $ref: '#/components/schemas/RequestMirrorPolicy' + description: Specifies the policy on how requests intended for the route's + backends are shadowed to a separate mirrored backend service. Loadbalancer + does not wait for responses from the shadow service. Prior to sending + traffic to the shadow service, the host / authority header is suffixed + with -shadow. Not supported when the URL map is bound to target gRPC proxy + that has validateForProxyless field set to true. + retryPolicy: + $ref: '#/components/schemas/HttpRetryPolicy' + description: Specifies the retry policy associated with this route. Not + supported when the URL map is bound to target gRPC proxy that has validateForProxyless + field set to true. + timeout: + $ref: '#/components/schemas/Duration' + description: Specifies the timeout for the selected route. Timeout is computed + from the time the request has been fully processed (i.e. end-of-stream) + up until the response has been completely processed. Timeout includes + all retries. If not specified, will use the largest timeout among all + backend services associated with the route. Not supported when the URL + map is bound to target gRPC proxy that has validateForProxyless field + set to true. + urlRewrite: + $ref: '#/components/schemas/UrlRewrite' + description: The spec to modify the URL of the request, prior to forwarding + the request to the matched service. urlRewrite is the only action supported + in UrlMaps for external HTTP(S) load balancers. Not supported when the + URL map is bound to target gRPC proxy that has validateForProxyless field + set to true. + weightedBackendServices: + description: A list of weighted backend services to send traffic to when + a route match occurs. The weights determine the fraction of traffic that + flows to their corresponding backend service. If all traffic needs to + go to a single backend service, there must be one weightedBackendService + with weight set to a non-zero number. Once a backendService is identified + and before forwarding the request to the backend service, advanced routing + actions such as URL rewrites and header transformations are applied depending + on additional settings specified in this HttpRouteAction. + items: + $ref: '#/components/schemas/WeightedBackendService' + type: array + type: object + HttpRouteRule: + description: An HttpRouteRule specifies how to match an HTTP request and the + corresponding routing action that load balancing proxies will perform. + properties: + description: + description: The short description conveying the intent of this routeRule. + The description can have a maximum length of 1024 characters. + type: string + headerAction: + $ref: '#/components/schemas/HttpHeaderAction' + description: Specifies changes to request and response headers that need + to take effect for the selected backendService. The headerAction specified + here are applied before the matching pathMatchers[].headerAction and after + pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction + Note that headerAction is not supported for Loadbalancers that have their + loadBalancingScheme set to EXTERNAL. Not supported when the URL map is + bound to target gRPC proxy that has validateForProxyless field set to + true. + matchRules: + description: 'The list of criteria for matching attributes of a request + to this routeRule. This list has OR semantics: the request matches this + routeRule when any of the matchRules are satisfied. However predicates + within a given matchRule have AND semantics. All predicates within a matchRule + must match for the request to match the rule.' + items: + $ref: '#/components/schemas/HttpRouteRuleMatch' + type: array + priority: + description: For routeRules within a given pathMatcher, priority determines + the order in which load balancer will interpret routeRules. RouteRules + are evaluated in order of priority, from the lowest to highest number. + The priority of a rule decreases as its number increases (1, 2, 3, N+1). + The first rule that matches the request is applied. You cannot configure + two or more routeRules with the same priority. Priority for each rule + must be set to a number between 0 and 2147483647 inclusive. Priority numbers + can have gaps, which enable you to add or remove rules in the future without + affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 + is a valid series of priority numbers to which you could add rules numbered + from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on + existing rules. + format: int32 + type: integer + routeAction: + $ref: '#/components/schemas/HttpRouteAction' + description: In response to a matching matchRule, the load balancer performs + advanced routing actions like URL rewrites, header transformations, etc. + prior to forwarding the request to the selected backend. If routeAction + specifies any weightedBackendServices, service must not be set. Conversely + if service is set, routeAction cannot contain any weightedBackendServices. + Only one of urlRedirect, service or routeAction.weightedBackendService + must be set. UrlMaps for external HTTP(S) load balancers support only + the urlRewrite action within a routeRule's routeAction. + service: + description: The full or partial URL of the backend service resource to + which traffic is directed if this rule is matched. If routeAction is additionally + specified, advanced routing actions like URL Rewrites, etc. take effect + prior to sending the request to the backend. However, if service is specified, + routeAction cannot contain any weightedBackendService s. Conversely, if + routeAction specifies any weightedBackendServices, service must not be + specified. Only one of urlRedirect, service or routeAction.weightedBackendService + must be set. + type: string + urlRedirect: + $ref: '#/components/schemas/HttpRedirectAction' + description: When this rule is matched, the request is redirected to a URL + specified by urlRedirect. If urlRedirect is specified, service or routeAction + must not be set. Not supported when the URL map is bound to target gRPC + proxy. + type: object + HttpRouteRuleMatch: + description: HttpRouteRuleMatch specifies a set of criteria for matching requests + to an HttpRouteRule. All specified criteria must be satisfied for a match + to occur. + properties: + fullPathMatch: + description: For satisfying the matchRule condition, the path of the request + must exactly match the value specified in fullPathMatch after removing + any query parameters and anchor that may be part of the original URL. + fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, + fullPathMatch or regexMatch must be specified. + type: string + headerMatches: + description: Specifies a list of header match criteria, all of which must + match corresponding headers in the request. + items: + $ref: '#/components/schemas/HttpHeaderMatch' + type: array + ignoreCase: + description: Specifies that prefixMatch and fullPathMatch matches are case + sensitive. The default value is false. ignoreCase must not be used with + regexMatch. Not supported when the URL map is bound to target gRPC proxy. + type: boolean + metadataFilters: + description: Opaque filter criteria used by Loadbalancer to restrict routing + configuration to a limited set of xDS compliant clients. In their xDS + requests to Loadbalancer, xDS clients present node metadata. When there + is a match, the relevant routing configuration is made available to those + proxies. For each metadataFilter in this list, if its filterMatchCriteria + is set to MATCH_ANY, at least one of the filterLabels must match the corresponding + label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, + then all of its filterLabels must match with corresponding labels provided + in the metadata. If multiple metadataFilters are specified, all of them + need to be satisfied in order to be considered a match. metadataFilters + specified here will be applied after those specified in ForwardingRule + that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters + only applies to Loadbalancers that have their loadBalancingScheme set + to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target + gRPC proxy that has validateForProxyless field set to true. + items: + $ref: '#/components/schemas/MetadataFilter' + type: array + prefixMatch: + description: For satisfying the matchRule condition, the request's path + must begin with the specified prefixMatch. prefixMatch must begin with + a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, + fullPathMatch or regexMatch must be specified. + type: string + queryParameterMatches: + description: Specifies a list of query parameter match criteria, all of + which must match corresponding query parameters in the request. Not supported + when the URL map is bound to target gRPC proxy. + items: + $ref: '#/components/schemas/HttpQueryParameterMatch' + type: array + regexMatch: + description: For satisfying the matchRule condition, the path of the request + must satisfy the regular expression specified in regexMatch after removing + any query parameters and anchor supplied with the original URL. For regular + expression grammar please see github.com/google/re2/wiki/Syntax Only one + of prefixMatch, fullPathMatch or regexMatch must be specified. Note that + regexMatch only applies to Loadbalancers that have their loadBalancingScheme + set to INTERNAL_SELF_MANAGED. + type: string + type: object + HttpsHealthCheck: + description: Represents a legacy HTTPS Health Check resource. Legacy HTTPS health + checks have been deprecated. If you are using a target pool-based network + load balancer, you must use a legacy HTTP (not HTTPS) health check. For all + other load balancers, including backend service-based network load balancers, + and for managed instance group auto-healing, you must use modern (non-legacy) + health checks. For more information, see Health checks overview . + properties: + checkIntervalSec: + description: How often (in seconds) to send a health check. The default + value is 5 seconds. + format: int32 + type: integer + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + healthyThreshold: + description: A so-far unhealthy instance will be marked healthy after this + many consecutive successes. The default value is 2. + format: int32 + type: integer + host: + description: The value of the host header in the HTTPS health check request. + If left empty (default value), the public IP on behalf of which this health + check is performed will be used. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#httpsHealthCheck + description: Type of the resource. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + port: + description: The TCP port number for the HTTPS health check request. The + default value is 443. + format: int32 + type: integer + requestPath: + description: The request path of the HTTPS health check request. The default + value is "/". + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + timeoutSec: + description: How long (in seconds) to wait before claiming failure. The + default value is 5 seconds. It is invalid for timeoutSec to have a greater + value than checkIntervalSec. + format: int32 + type: integer + unhealthyThreshold: + description: A so-far healthy instance will be marked unhealthy after this + many consecutive failures. The default value is 2. + format: int32 + type: integer + type: object + HttpsHealthCheckList: + description: Contains a list of HttpsHealthCheck resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of HttpsHealthCheck resources. + items: + $ref: '#/components/schemas/HttpsHealthCheck' + type: array + kind: + default: compute#httpsHealthCheckList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Image: + description: Represents an Image resource. You can use images to create boot + disks for your VM instances. For more information, read Images. + properties: + archiveSizeBytes: + description: Size of the image tar.gz archive stored in Google Cloud Storage + (in bytes). + format: int64 + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: The deprecation status associated with this image. + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + diskSizeGb: + description: Size of the image when restored onto a persistent disk (in + GB). + format: int64 + type: string + family: + description: The name of the image family to which this image belongs. You + can create disks by specifying 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 + 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. + items: + $ref: '#/components/schemas/GuestOsFeature' + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + imageEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: Encrypts the image using a customer-supplied encryption key. + After you encrypt an image with a customer-supplied key, you must provide + the same key if you use the image later (e.g. to create a disk from the + image). Customer-supplied encryption keys do not protect access to metadata + of the disk. If you do not provide an encryption key when creating the + image, then the disk will be encrypted using an automatically generated + key and you do not need to provide a key to use the image later. + kind: + default: compute#image + description: '[Output Only] Type of the resource. Always compute#image for + images.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this image, which + is essentially a hash of the labels used for optimistic locking. The fingerprint + is initially generated by Compute Engine and changes after every request + to modify or update labels. You must always provide an up-to-date fingerprint + hash in order to update or change labels, otherwise the request will fail + with error 412 conditionNotMet. To see the latest fingerprint, make a + get() request to retrieve an image. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this image. These can be later modified + by the setLabels method. + type: object + licenseCodes: + description: Integer license codes indicating which licenses are attached + to this image. + items: + format: int64 + type: string + type: array + licenses: + description: Any applicable license URI. + items: + type: string + type: array + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + rawDisk: + description: The parameters of the raw disk image. + properties: + containerType: + description: The format used to encode and transmit the block device, + which should be TAR. This is just a container and transmission format + and not a runtime format. Provided by the client when the disk image + is created. + enum: + - TAR + type: string + sha1Checksum: + 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 + source: + description: 'The full Google Cloud Storage URL where the raw disk image + archive is stored. The following are valid formats for the URL: - + https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ + image_archive_name In order to create an image, you must provide the + full or partial URL of one of the following: - The rawDisk.source + URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot + URL ' + type: string + type: object + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + shieldedInstanceInitialState: + $ref: '#/components/schemas/InitialStateConfig' + description: Set the secure boot keys of shielded instance. + sourceDisk: + description: 'URL of the source disk used to create this image. For example, + the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + In order to create an image, you must provide the full or partial URL + of one of the following: - The rawDisk.source URL - The sourceDisk URL + - The sourceImage URL - The sourceSnapshot URL ' + type: string + sourceDiskEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source disk. Required + if the source disk is protected by a customer-supplied encryption key. + sourceDiskId: + description: '[Output Only] The ID value of the disk used to create this + image. This value may be used to determine whether the image was taken + from the current or a previous instance of a given disk name.' + type: string + sourceImage: + description: 'URL of the source image used to create this image. The following + are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ + images/image_name - projects/project_id/global/images/image_name In order + to create an image, you must provide the full or partial URL of one of + the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage + URL - The sourceSnapshot URL ' + type: string + sourceImageEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption key. + sourceImageId: + description: '[Output Only] The ID value of the image used to create this + image. This value may be used to determine whether the image was taken + from the current or a previous instance of a given image name.' + type: string + sourceSnapshot: + description: 'URL of the source snapshot used to create this image. The + following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ + snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name + In order to create an image, you must provide the full or partial URL + of one of the following: - The rawDisk.source URL - The sourceDisk URL + - The sourceImage URL - The sourceSnapshot URL ' + type: string + sourceSnapshotEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source snapshot. + Required if the source snapshot is protected by a customer-supplied encryption + key. + sourceSnapshotId: + description: '[Output Only] The ID value of the snapshot used to create + this image. This value may be used to determine whether the snapshot was + taken from the current or a previous instance of a given snapshot name.' + type: string + sourceType: + default: RAW + description: The type of the image used to create this disk. The default + and only value is RAW + enum: + - RAW + type: string + status: + description: '[Output Only] The status of the image. An image can be used + to create other resources, such as instances, only after the image has + been successfully created and the status is set to READY. Possible values + are FAILED, PENDING, or READY.' + enum: + - DELETING + - FAILED + - PENDING + - READY + type: string + storageLocations: + description: Cloud Storage bucket storage location of the image (regional + or multi-regional). + items: + type: string + type: array + type: object + ImageFamilyView: + properties: + image: + $ref: '#/components/schemas/Image' + description: The latest image that is part of the specified image family + in the requested location, and that is not deprecated. + type: object + ImageList: + description: Contains a list of images. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Image resources. + items: + $ref: '#/components/schemas/Image' + type: array + kind: + default: compute#imageList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InitialStateConfig: + description: Initial State for shielded instance, these are public keys which + are safe to store in public + properties: + dbs: + description: The Key Database (db). + items: + $ref: '#/components/schemas/FileContentBuffer' + type: array + dbxs: + description: The forbidden key database (dbx). + items: + $ref: '#/components/schemas/FileContentBuffer' + type: array + keks: + description: The Key Exchange Key (KEK). + items: + $ref: '#/components/schemas/FileContentBuffer' + type: array + pk: + $ref: '#/components/schemas/FileContentBuffer' + description: The Platform Key (PK). + type: object + Instance: + description: Represents an Instance resource. An instance is a virtual machine + that is hosted on Google Cloud Platform. For more information, read Virtual + Machine Instances. + properties: + advancedMachineFeatures: + $ref: '#/components/schemas/AdvancedMachineFeatures' + description: Controls for advanced machine-related behavior features. + canIpForward: + description: Allows this instance to send and receive packets with non-matching + destination or source IPs. This is required if you plan to use this instance + to forward routes. For more information, see Enabling IP Forwarding . + type: boolean + confidentialInstanceConfig: + $ref: '#/components/schemas/ConfidentialInstanceConfig' + cpuPlatform: + description: '[Output Only] The CPU platform used by this instance.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deletionProtection: + description: Whether the resource should be protected against deletion. + type: boolean + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + disks: + description: Array of disks associated with this instance. Persistent disks + must be created before you can assign them. + items: + $ref: '#/components/schemas/AttachedDisk' + type: array + displayDevice: + $ref: '#/components/schemas/DisplayDevice' + description: Enables display device for the instance. + fingerprint: + description: Specifies a fingerprint for this resource, which is essentially + a hash of the instance's contents and used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update the instance. You must always provide + an up-to-date fingerprint hash in order to update the instance. To see + the latest fingerprint, make get() request to the instance. + format: byte + type: string + guestAccelerators: + description: A list of the type and count of accelerator cards attached + to the instance. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + hostname: + description: Specifies the hostname of the instance. The specified hostname + must be RFC1035 compliant. If hostname is not specified, the default hostname + is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, + and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#instance + description: '[Output Only] Type of the resource. Always compute#instance + for instances.' + type: string + labelFingerprint: + description: A fingerprint for this request, which is essentially a hash + of the label's contents and used for optimistic locking. The fingerprint + is initially generated by Compute Engine and changes after every request + to modify or update labels. You must always provide an up-to-date fingerprint + hash in order to update or change labels. To see the latest fingerprint, + make get() request to the instance. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this instance. These can be later modified + by the setLabels method. + type: object + lastStartTimestamp: + description: '[Output Only] Last start timestamp in RFC3339 text format.' + type: string + lastStopTimestamp: + description: '[Output Only] Last stop timestamp in RFC3339 text format.' + type: string + lastSuspendedTimestamp: + description: '[Output Only] Last suspended timestamp in RFC3339 text format.' + type: string + machineType: + description: 'Full or partial URL of the machine type resource to use for + this instance, in the format: zones/zone/machineTypes/machine-type. This + is provided by the client when the instance is created. For example, the + following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 + To create a custom machine type, provide a URL to a machine type in the + following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, + ... 24, etc), and MEMORY is the total memory for this instance. Memory + must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of + memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: + zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, + read the Specifications for custom machine types.' + type: string + metadata: + $ref: '#/components/schemas/Metadata' + description: The metadata key/value pairs assigned to this instance. This + includes custom metadata and predefined keys. + minCpuPlatform: + description: 'Specifies a minimum CPU platform for the VM instance. Applicable + values are the friendly names of CPU platforms, such as minCpuPlatform: + "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".' + type: string + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + networkInterfaces: + description: An array of network configurations for this instance. These + specify how interfaces are configured to interact with other network services, + such as connecting to the internet. Multiple interfaces are supported + per instance. + items: + $ref: '#/components/schemas/NetworkInterface' + type: array + privateIpv6GoogleAccess: + description: The private IPv6 google access type for the VM. If not specified, + use INHERIT_FROM_SUBNETWORK as default. + enum: + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + - INHERIT_FROM_SUBNETWORK + type: string + reservationAffinity: + $ref: '#/components/schemas/ReservationAffinity' + description: Specifies the reservations that this instance can consume from. + resourcePolicies: + description: Resource policies applied to this instance. + items: + type: string + type: array + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + scheduling: + $ref: '#/components/schemas/Scheduling' + description: Sets the scheduling options for this instance. + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + serviceAccounts: + description: A list of service accounts, with their specified scopes, authorized + for this instance. Only one service account per VM instance is supported. + Service accounts generate access tokens that can be accessed through the + metadata server and used to authenticate applications on the instance. + See Service Accounts for more information. + items: + $ref: '#/components/schemas/ServiceAccount' + type: array + shieldedInstanceConfig: + $ref: '#/components/schemas/ShieldedInstanceConfig' + shieldedInstanceIntegrityPolicy: + $ref: '#/components/schemas/ShieldedInstanceIntegrityPolicy' + startRestricted: + description: '[Output Only] Whether a VM has been restricted for start because + Compute Engine has detected suspicious activity.' + type: boolean + status: + description: '[Output Only] The status of the instance. One of the following + values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, + REPAIRING, and TERMINATED. For more information about the status of the + instance, see Instance life cycle.' + enum: + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED + type: string + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the + status.' + type: string + tags: + $ref: '#/components/schemas/Tags' + description: Tags to apply to this instance. Tags are used to identify valid + sources or targets for network firewalls and are specified by the client + during instance creation. The tags can be later modified by the setTags + method. Each tag within the list must comply with RFC1035. Multiple tags + can be specified via the 'tags.items' field. + zone: + description: '[Output Only] URL of the zone where the instance resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + type: object + InstanceAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/InstancesScopedList' + description: '[Output Only] Name of the scope containing this set of instances.' + description: An object that contains a list of instances scoped by zone. + type: object + kind: + default: compute#instanceAggregatedList + description: '[Output Only] Type of resource. Always compute#instanceAggregatedList + for aggregated lists of Instance resources.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroup: + description: Represents an Instance Group resource. Instance Groups can be used + to configure a target for load balancing. Instance groups can either be managed + or unmanaged. To create managed instance groups, use the instanceGroupManager + or regionInstanceGroupManager resource instead. Use zonal unmanaged instance + groups if you need to apply load balancing to groups of heterogeneous instances + or if you need to manage the instances yourself. You cannot create regional + unmanaged instance groups. For more information, read Instance groups. + properties: + creationTimestamp: + description: '[Output Only] The creation timestamp for this instance group + in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: '[Output Only] The fingerprint of the named ports. The system + uses this fingerprint to detect conflicts when multiple users change the + named ports concurrently.' + format: byte + type: string + id: + description: '[Output Only] A unique identifier for this instance group, + generated by the server.' + format: uint64 + type: string + kind: + default: compute#instanceGroup + description: '[Output Only] The resource type, which is always compute#instanceGroup + for instance groups.' + type: string + name: + description: The name of the instance group. 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 + namedPorts: + description: ' Assigns a name to a port number. For example: {name: "http", + port: 80} This allows the system to reference ports by the assigned name + instead of a port number. Named ports can also contain multiple ports. + For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named + ports apply to all instances in this instance group. ' + items: + $ref: '#/components/schemas/NamedPort' + type: array + network: + description: '[Output Only] The URL of the network to which all instances + in the instance group belong. If your instance has multiple network interfaces, + then the network and subnetwork fields only refer to the network and subnet + used by your primary interface (nic0).' + type: string + region: + description: '[Output Only] The URL of the region where the instance group + is located (for regional resources).' + type: string + selfLink: + description: '[Output Only] The URL for this instance group. The server + generates this URL.' + type: string + size: + description: '[Output Only] The total number of instances in the instance + group.' + format: int32 + type: integer + subnetwork: + description: '[Output Only] The URL of the subnetwork to which all instances + in the instance group belong. If your instance has multiple network interfaces, + then the network and subnetwork fields only refer to the network and subnet + used by your primary interface (nic0).' + type: string + zone: + description: '[Output Only] The URL of the zone where the instance group + is located (for zonal resources).' + type: string + type: object + InstanceGroupAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/InstanceGroupsScopedList' + description: The name of the scope that contains this set of instance + groups. + description: A list of InstanceGroupsScopedList resources. + type: object + kind: + default: compute#instanceGroupAggregatedList + description: '[Output Only] The resource type, which is always compute#instanceGroupAggregatedList + for aggregated lists of instance groups.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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. + 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: '#/components/schemas/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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManager: + description: Represents a Managed Instance Group resource. An instance group + is a collection of VM instances that you can manage as a single entity. For + more information, read Instance groups. For zonal Managed Instance Group, + use the instanceGroupManagers resource. For regional Managed Instance Group, + use the regionInstanceGroupManagers resource. + properties: + autoHealingPolicies: + description: The autohealing policy for this managed instance group. You + can specify only one value. + items: + $ref: '#/components/schemas/InstanceGroupManagerAutoHealingPolicy' + type: array + baseInstanceName: + description: The base instance name to use for instances in this group. + The value must be 1-58 characters long. Instances are named by appending + a hyphen and a random four-character string to the base instance name. + The base instance name must comply with RFC1035. + pattern: '[a-z][-a-z0-9]{0,57}' + type: string + creationTimestamp: + description: '[Output Only] The creation timestamp for this managed instance + group in RFC3339 text format.' + type: string + currentActions: + $ref: '#/components/schemas/InstanceGroupManagerActionsSummary' + description: '[Output Only] The list of instance actions and the number + of instances in this managed instance group that are scheduled for each + of those actions.' + description: + description: An optional description of this resource. + type: string + distributionPolicy: + $ref: '#/components/schemas/DistributionPolicy' + description: Policy specifying the intended distribution of managed instances + across zones in a regional managed instance group. + fingerprint: + description: 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. + format: byte + type: string + id: + description: '[Output Only] A unique identifier for this resource type. + The server generates this identifier.' + format: uint64 + type: string + instanceGroup: + description: '[Output Only] The URL of the Instance Group resource.' + type: string + 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 + kind: + default: compute#instanceGroupManager + description: '[Output Only] The resource type, which is always compute#instanceGroupManager + for managed instance groups.' + type: string + name: + description: The name of the managed instance group. 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 + namedPorts: + description: Named ports configured for the Instance Groups complementary + to this Instance Group Manager. + items: + $ref: '#/components/schemas/NamedPort' + type: array + region: + description: '[Output Only] The URL of the region where the managed instance + group resides (for regional resources).' + type: string + selfLink: + description: '[Output Only] The URL for this managed instance group. The + server defines this URL.' + type: string + statefulPolicy: + $ref: '#/components/schemas/StatefulPolicy' + description: Stateful configuration for this Instanced Group Manager + status: + $ref: '#/components/schemas/InstanceGroupManagerStatus' + description: '[Output Only] The status of this managed instance group.' + targetPools: + description: The URLs for all TargetPool resources to which instances in + the instanceGroup field are added. The target pools automatically apply + to all of the instances in the managed instance group. + items: + type: string + type: array + targetSize: + description: The target number of running instances for this managed instance + group. You can reduce this number by using the instanceGroupManager deleteInstances + or abandonInstances methods. Resizing the group also changes this number. + format: int32 + type: integer + updatePolicy: + $ref: '#/components/schemas/InstanceGroupManagerUpdatePolicy' + description: The update policy for this managed instance group. + versions: + description: Specifies the instance templates used by this managed instance + group to create instances. Each version is defined by an instanceTemplate + and a name. Every version can appear at most once per instance group. + This field overrides the top-level instanceTemplate field. Read more about + the relationships between these fields. Exactly one version must leave + the targetSize field unset. That version will be applied to all remaining + instances. For more information, read about canary updates. + items: + $ref: '#/components/schemas/InstanceGroupManagerVersion' + type: array + zone: + description: '[Output Only] The URL of a zone where the managed instance + group is located (for zonal resources).' + type: string + type: object + InstanceGroupManagerActionsSummary: + properties: + abandoning: + description: '[Output Only] The total number of instances in the managed + instance group that are scheduled to be abandoned. Abandoning an instance + removes it from the managed instance group without deleting it.' + format: int32 + type: integer + creating: + description: '[Output Only] The number of instances in the managed instance + group that are scheduled to be created or are currently being created. + If the group fails to create any of these instances, it tries again until + it creates the instance successfully. If you have disabled creation retries, + this field will not be populated; instead, the creatingWithoutRetries + field will be populated.' + format: int32 + type: integer + creatingWithoutRetries: + description: '[Output Only] The number of instances that the managed instance + group will attempt to create. The group attempts to create each instance + only once. If the group fails to create any of these instances, it decreases + the group''s targetSize value accordingly.' + format: int32 + type: integer + deleting: + description: '[Output Only] The number of instances in the managed instance + group that are scheduled to be deleted or are currently being deleted.' + format: int32 + type: integer + none: + description: '[Output Only] The number of instances in the managed instance + group that are running and have no scheduled actions.' + format: int32 + type: integer + recreating: + description: '[Output Only] The number of instances in the managed instance + group that are scheduled to be recreated or are currently being being + recreated. Recreating an instance deletes the existing root persistent + disk and creates a new disk from the image that is defined in the instance + template.' + format: int32 + type: integer + refreshing: + description: '[Output Only] The number of instances in the managed instance + group that are being reconfigured with properties that do not require + a restart or a recreate action. For example, setting or removing target + pools for the instance.' + format: int32 + type: integer + restarting: + description: '[Output Only] The number of instances in the managed instance + group that are scheduled to be restarted or are currently being restarted.' + format: int32 + type: integer + verifying: + description: '[Output Only] The number of instances in the managed instance + group that are being verified. See the managedInstances[].currentAction + property in the listManagedInstances method documentation.' + format: int32 + type: integer + type: object + InstanceGroupManagerAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/InstanceGroupManagersScopedList' + description: '[Output Only] The name of the scope that contains this set + of managed instance groups.' + description: A list of InstanceGroupManagersScopedList resources. + type: object + kind: + default: compute#instanceGroupManagerAggregatedList + description: '[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList + for an aggregated list of managed instance groups.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManagerAutoHealingPolicy: + properties: + healthCheck: + description: The URL for the health check that signals autohealing. + type: string + initialDelaySec: + description: The number of seconds that the managed instance group waits + before it applies autohealing policies to new instances or recently recreated + instances. This initial delay allows instances to initialize and run their + startup scripts before the instance group determines that they are UNHEALTHY. + This prevents the managed instance group from recreating its instances + prematurely. This value must be from range [0, 3600]. + format: int32 + type: integer + type: object + InstanceGroupManagerList: + description: '[Output Only] A list of managed instance groups.' + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceGroupManager resources. + items: + $ref: '#/components/schemas/InstanceGroupManager' + type: array + kind: + default: compute#instanceGroupManagerList + description: '[Output Only] The resource type, which is always compute#instanceGroupManagerList + for a list of managed instance groups.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManagerStatus: + properties: + autoscaler: + description: '[Output Only] The URL of the Autoscaler that targets this + instance group manager.' + type: string + isStable: + description: '[Output Only] A bit indicating whether the managed instance + group is in a stable state. A stable state means that: none of the instances + in the managed instance group is currently undergoing any type of change + (for example, creation, restart, or deletion); no future changes are scheduled + for instances in the managed instance group; and the managed instance + group itself is not being modified.' + type: boolean + stateful: + $ref: '#/components/schemas/InstanceGroupManagerStatusStateful' + description: '[Output Only] Stateful status of the given Instance Group + Manager.' + versionTarget: + $ref: '#/components/schemas/InstanceGroupManagerStatusVersionTarget' + description: '[Output Only] A status of consistency of Instances'' versions + with their target version specified by version field on Instance Group + Manager.' + type: object + InstanceGroupManagerStatusStateful: + properties: + hasStatefulConfig: + 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 config 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.' + type: boolean + perInstanceConfigs: + $ref: '#/components/schemas/InstanceGroupManagerStatusStatefulPerInstanceConfigs' + description: '[Output Only] Status of per-instance configs on the instance.' + type: object + InstanceGroupManagerStatusStatefulPerInstanceConfigs: + properties: + allEffective: + description: A bit indicating if all of the group's per-instance configs + (listed in the output of a listPerInstanceConfigs API call) have status + EFFECTIVE or there are no per-instance-configs. + type: boolean + type: object + InstanceGroupManagerStatusVersionTarget: + properties: + isReached: + description: '[Output Only] A bit indicating whether version target has + been reached in this managed instance group, i.e. all instances are in + their target version. Instances'' target version are specified by version + field on Instance Group Manager.' + type: boolean + type: object + InstanceGroupManagerUpdatePolicy: + properties: + instanceRedistributionType: + description: 'The instance redistribution policy for regional managed instance + groups. Valid values are: - PROACTIVE (default): The group attempts to + maintain an even distribution of VM instances across zones in the region. + - NONE: For non-autoscaled groups, proactive redistribution is disabled. ' + enum: + - NONE + - PROACTIVE + type: string + maxSurge: + $ref: '#/components/schemas/FixedOrPercent' + description: The maximum number of instances that can be created above the + specified targetSize during the update process. This value can be either + a fixed number or, if the group has 10 or more instances, a percentage. + If you set a percentage, the number of instances is rounded if necessary. + The default value for maxSurge is a fixed value equal to the number of + zones in which the managed instance group operates. At least one of either + maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. + maxUnavailable: + $ref: '#/components/schemas/FixedOrPercent' + description: 'The maximum number of instances that can be unavailable during + the update process. An instance is considered available if all of the + following conditions are satisfied: - The instance''s status is RUNNING. + - If there is a health check on the instance group, the instance''s health + check status must be HEALTHY at least once. If there is no health check + on the group, then the instance only needs to have a status of RUNNING + to be considered available. This value can be either a fixed number or, + if the group has 10 or more instances, a percentage. If you set a percentage, + the number of instances is rounded if necessary. The default value for + maxUnavailable is a fixed value equal to the number of zones in which + the managed instance group operates. At least one of either maxSurge or + maxUnavailable must be greater than 0. Learn more about maxUnavailable.' + minimalAction: + description: Minimal action to be taken on an instance. You can specify + either RESTART to restart existing instances or REPLACE to delete and + create new instances from the target template. If you specify a RESTART, + the Updater will attempt to perform that action only. However, if the + Updater determines that the minimal action you specify is not enough to + perform the update, it might perform a more disruptive action. + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + replacementMethod: + description: What action should be used to replace instances. See minimal_action.REPLACE + enum: + - RECREATE + - SUBSTITUTE + type: string + type: + description: The type of update process. You can specify either PROACTIVE + so that the instance group manager proactively executes actions in order + to bring instances to their target versions or OPPORTUNISTIC so that no + action is proactively executed but the update will be performed as part + of other actions (for example, resizes or recreateInstances calls). + enum: + - OPPORTUNISTIC + - PROACTIVE + type: string + type: object + InstanceGroupManagerVersion: + properties: + instanceTemplate: + description: The URL of the instance template that is specified for this + managed instance group. The group uses this template to create new instances + in the managed instance group until the `targetSize` for this version + is reached. 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; in those cases, existing instances + are updated until the `targetSize` for this version is reached. + type: string + name: + description: Name of the version. Unique among all versions in the scope + of this managed instance group. + type: string + targetSize: + $ref: '#/components/schemas/FixedOrPercent' + description: 'Specifies the intended number of instances to be created from + the instanceTemplate. The final number of instances created from the template + will be equal to: - If expressed as a fixed number, the minimum of either + targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed + as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) + If there is a remainder, the number is rounded. If unset, this version + will update any remaining instances not updated by another version. Read + Starting a canary update for more information.' + type: object + InstanceGroupManagersAbandonInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to abandon. This can be a + full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + type: object + InstanceGroupManagersApplyUpdatesRequest: + description: InstanceGroupManagers.applyUpdatesToInstances + properties: + allInstances: + description: "Flag to update all instances instead of specified list of\ + \ \u201Cinstances\u201D. If the flag is set to true then the instances\ + \ may not be specified in the request." + type: boolean + instances: + description: The list of URLs of one or more instances for which you want + to apply updates. Each URL can be a full URL or a partial URL, such as + zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + minimalAction: + description: 'The minimal action that you want to perform on each instance + during the update: - REPLACE: At minimum, delete the instance and create + it again. - RESTART: Stop the instance and start it again. - REFRESH: + Do not stop the instance. - NONE: Do not disrupt the instance at all. + By default, the minimum action is NONE. If your update requires a more + disruptive action than you set with this flag, the necessary action is + performed to execute the update.' + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + mostDisruptiveAllowedAction: + description: 'The most disruptive action that you want to perform on each + instance during the update: - REPLACE: Delete the instance and create + it again. - RESTART: Stop the instance and start it again. - REFRESH: + Do not stop the instance. - NONE: Do not disrupt the instance at all. + By default, the most disruptive allowed action is REPLACE. If your update + requires a more disruptive action than you set with this flag, the update + request will fail.' + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + type: object + InstanceGroupManagersCreateInstancesRequest: + description: InstanceGroupManagers.createInstances + properties: + instances: + description: '[Required] List of specifications of per-instance configs.' + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + InstanceGroupManagersDeleteInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to delete. This can be a + full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + skipInstancesOnValidationError: + description: Specifies whether the request should proceed despite the inclusion + of instances that are not members of the group or that are already in + the process of being deleted or abandoned. If this field is set to `false` + and such an instance is specified in the request, the operation fails. + The operation always fails if the request contains a malformed instance + URL or a reference to an instance that exists in a zone or region other + than the group's zone or region. + type: boolean + type: object + InstanceGroupManagersDeletePerInstanceConfigsReq: + description: InstanceGroupManagers.deletePerInstanceConfigs + properties: + names: + description: The list of instance names for which we want to delete per-instance + configs on this managed instance group. + items: + type: string + type: array + type: object + InstanceGroupManagersListErrorsResponse: + properties: + items: + description: '[Output Only] The list of errors of the managed instance group.' + items: + $ref: '#/components/schemas/InstanceManagedByIgmError' + type: array + 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 + type: object + InstanceGroupManagersListManagedInstancesResponse: + properties: + managedInstances: + description: '[Output Only] The list of instances in the managed instance + group.' + items: + $ref: '#/components/schemas/ManagedInstance' + type: array + 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 + type: object + InstanceGroupManagersListPerInstanceConfigsResp: + properties: + items: + description: '[Output Only] The list of PerInstanceConfig.' + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManagersPatchPerInstanceConfigsReq: + description: InstanceGroupManagers.patchPerInstanceConfigs + properties: + perInstanceConfigs: + description: The list of per-instance configs to insert or patch on this + managed instance group. + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + InstanceGroupManagersRecreateInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to recreate. This can be + a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + type: object + InstanceGroupManagersScopedList: + properties: + instanceGroupManagers: + description: '[Output Only] The list of managed instance groups that are + contained in the specified project and zone.' + items: + $ref: '#/components/schemas/InstanceGroupManager' + type: array + warning: + description: '[Output Only] The warning that replaces the list of managed + instance groups 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupManagersSetInstanceTemplateRequest: + properties: + 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 + type: object + InstanceGroupManagersSetTargetPoolsRequest: + properties: + fingerprint: + description: The fingerprint of the target pools information. Use this optional + property to prevent conflicts when multiple users change the target pools + settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get + method. Then, include the fingerprint in your request to ensure that you + do not overwrite changes that were applied from another concurrent request. + format: byte + type: string + targetPools: + description: The list of target pool URLs that instances in this managed + instance group belong to. The managed instance group applies these target + pools to all of the instances in the group. Existing instances and new + instances in the group all receive these target pool settings. + items: + type: string + type: array + type: object + InstanceGroupManagersUpdatePerInstanceConfigsReq: + description: InstanceGroupManagers.updatePerInstanceConfigs + properties: + perInstanceConfigs: + description: The list of per-instance configs to insert or patch on this + managed instance group. + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + InstanceGroupsAddInstancesRequest: + properties: + instances: + description: The list of instances to add to the instance group. + items: + $ref: '#/components/schemas/InstanceReference' + type: array + type: object + InstanceGroupsListInstances: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceWithNamedPorts resources. + items: + $ref: '#/components/schemas/InstanceWithNamedPorts' + type: array + kind: + default: compute#instanceGroupsListInstances + description: '[Output Only] The resource type, which is always compute#instanceGroupsListInstances + for the list of instances in the specified instance group.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupsListInstancesRequest: + properties: + instanceState: + description: A filter for the state of the instances in the instance group. + Valid options are ALL or RUNNING. If you do not specify this parameter + the list includes all instances regardless of their state. + enum: + - ALL + - RUNNING + type: string + type: object + InstanceGroupsRemoveInstancesRequest: + properties: + instances: + description: The list of instances to remove from the instance group. + items: + $ref: '#/components/schemas/InstanceReference' + type: array + type: object + InstanceGroupsScopedList: + properties: + instanceGroups: + description: '[Output Only] The list of instance groups that are contained + in this scope.' + items: + $ref: '#/components/schemas/InstanceGroup' + type: array + warning: + description: '[Output Only] An informational warning that replaces the list + of instance groups 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceGroupsSetNamedPortsRequest: + properties: + fingerprint: + description: The fingerprint of the named ports information for this instance + group. Use this optional property to prevent conflicts when multiple users + change the named ports settings concurrently. Obtain the fingerprint with + the instanceGroups.get method. Then, include the fingerprint in your request + to ensure that you do not overwrite changes that were applied from another + concurrent request. A request with an incorrect fingerprint will fail + with error 412 conditionNotMet. + format: byte + type: string + namedPorts: + description: The list of named ports to set for this instance group. + items: + $ref: '#/components/schemas/NamedPort' + type: array + type: object + InstanceList: + description: Contains a list of instances. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Instance resources. + items: + $ref: '#/components/schemas/Instance' + type: array + kind: + default: compute#instanceList + description: '[Output Only] Type of resource. Always compute#instanceList + for lists of Instance resources.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceListReferrers: + description: Contains a list of instance referrers. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Reference resources. + items: + $ref: '#/components/schemas/Reference' + type: array + kind: + default: compute#instanceListReferrers + description: '[Output Only] Type of resource. Always compute#instanceListReferrers + for lists of Instance referrers.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceManagedByIgmError: + properties: + error: + $ref: '#/components/schemas/InstanceManagedByIgmErrorManagedInstanceError' + description: '[Output Only] Contents of the error.' + instanceActionDetails: + $ref: '#/components/schemas/InstanceManagedByIgmErrorInstanceActionDetails' + description: '[Output Only] Details of the instance action that triggered + this error. May be null, if the error was not caused by an action on an + instance. This field is optional.' + timestamp: + description: '[Output Only] The time that this error occurred. This value + is in RFC3339 text format.' + type: string + type: object + InstanceManagedByIgmErrorInstanceActionDetails: + properties: + action: + description: '[Output Only] Action that managed instance group was executing + on the instance when the error occurred. Possible values:' + enum: + - ABANDONING + - CREATING + - CREATING_WITHOUT_RETRIES + - DELETING + - NONE + - RECREATING + - REFRESHING + - RESTARTING + - VERIFYING + type: string + instance: + description: '[Output Only] The URL of the instance. The URL can be set + even if the instance has not yet been created.' + type: string + version: + $ref: '#/components/schemas/ManagedInstanceVersion' + description: '[Output Only] Version this instance was created from, or was + being created from, but the creation failed. Corresponds to one of the + versions that were set on the Instance Group Manager resource at the time + this instance was being created.' + type: object + InstanceManagedByIgmErrorManagedInstanceError: + properties: + code: + description: '[Output Only] Error code.' + type: string + message: + description: '[Output Only] Error message.' + type: string + type: object + InstanceMoveRequest: + properties: + destinationZone: + description: 'The URL of the destination zone to move the instance. This + can be a full or partial URL. For example, the following are all valid + URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + - projects/project/zones/zone - zones/zone ' + type: string + targetInstance: + description: 'The URL of the target instance to move. This can be a full + or partial URL. For example, the following are all valid URLs to an instance: + - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance + - projects/project/zones/zone/instances/instance - zones/zone/instances/instance ' + type: string + type: object + InstanceProperties: + properties: + advancedMachineFeatures: + $ref: '#/components/schemas/AdvancedMachineFeatures' + description: Controls for advanced machine-related behavior features. Note + that for MachineImage, this is not supported yet. + canIpForward: + description: Enables instances created based on these properties to send + packets with source IP addresses other than their own and receive packets + with destination IP addresses other than their own. If these instances + will be used as an IP gateway or it will be set as the next-hop in a Route + resource, specify true. If unsure, leave this set to false. See the Enable + IP forwarding documentation for more information. + type: boolean + confidentialInstanceConfig: + $ref: '#/components/schemas/ConfidentialInstanceConfig' + description: Specifies the Confidential Instance options. Note that for + MachineImage, this is not supported yet. + description: + description: An optional text description for the instances that are created + from these properties. + type: string + disks: + description: An array of disks that are associated with the instances that + are created from these properties. + items: + $ref: '#/components/schemas/AttachedDisk' + type: array + guestAccelerators: + description: A list of guest accelerator cards' type and count to use for + instances created from these properties. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + labels: + additionalProperties: + type: string + description: Labels to apply to instances that are created from these properties. + type: object + machineType: + description: The machine type to use for instances that are created from + these properties. + type: string + metadata: + $ref: '#/components/schemas/Metadata' + description: The metadata key/value pairs to assign to instances that are + created from these properties. These pairs can consist of custom metadata + or predefined keys. See Project and instance metadata for more information. + minCpuPlatform: + description: 'Minimum cpu/platform to be used by instances. The instance + may be scheduled on the specified or newer cpu/platform. Applicable values + are the friendly names of CPU platforms, such as minCpuPlatform: "Intel + Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, + read Specifying a Minimum CPU Platform.' + type: string + networkInterfaces: + description: An array of network access configurations for this interface. + items: + $ref: '#/components/schemas/NetworkInterface' + type: array + privateIpv6GoogleAccess: + description: The private IPv6 google access type for VMs. If not specified, + use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this + is not supported yet. + enum: + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + - INHERIT_FROM_SUBNETWORK + type: string + reservationAffinity: + $ref: '#/components/schemas/ReservationAffinity' + description: Specifies the reservations that instances can consume from. + Note that for MachineImage, this is not supported yet. + resourcePolicies: + description: Resource policies (names, not ULRs) applied to instances created + from these properties. Note that for MachineImage, this is not supported + yet. + items: + type: string + type: array + scheduling: + $ref: '#/components/schemas/Scheduling' + description: Specifies the scheduling options for the instances that are + created from these properties. + serviceAccounts: + description: A list of service accounts with specified scopes. Access tokens + for these service accounts are available to the instances that are created + from these properties. Use metadata queries to obtain the access tokens + for these instances. + items: + $ref: '#/components/schemas/ServiceAccount' + type: array + shieldedInstanceConfig: + $ref: '#/components/schemas/ShieldedInstanceConfig' + description: Note that for MachineImage, this is not supported yet. + tags: + $ref: '#/components/schemas/Tags' + description: A list of tags to apply to the instances that are created from + these properties. The tags identify valid sources or targets for network + firewalls. The setTags method can modify this list of tags. Each tag within + the list must comply with RFC1035. + type: object + InstanceReference: + properties: + instance: + description: The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances + type: string + type: object + InstanceTemplate: + description: Represents an Instance Template resource. You can use instance + templates to create VM instances and managed instance groups. For more information, + read Instance Templates. + properties: + creationTimestamp: + description: '[Output Only] The creation timestamp for this instance template + in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] A unique identifier for this instance template. + The server defines this identifier.' + format: uint64 + type: string + kind: + default: compute#instanceTemplate + description: '[Output Only] The resource type, which is always compute#instanceTemplate + for instance templates.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + properties: + $ref: '#/components/schemas/InstanceProperties' + description: The instance properties for this instance template. + selfLink: + description: '[Output Only] The URL for this instance template. The server + defines this URL.' + type: string + sourceInstance: + description: 'The source instance used to create the template. You can provide + this as a partial or full URL to the resource. For example, the following + are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /instances/instance - projects/project/zones/zone/instances/instance ' + type: string + sourceInstanceParams: + $ref: '#/components/schemas/SourceInstanceParams' + description: The source instance params to use to create this instance template. + type: object + InstanceTemplateList: + description: A list of instance templates. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceTemplate resources. + items: + $ref: '#/components/schemas/InstanceTemplate' + type: array + kind: + default: compute#instanceTemplateList + description: '[Output Only] The resource type, which is always compute#instanceTemplatesListResponse + for instance template 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstanceWithNamedPorts: + properties: + instance: + description: '[Output Only] The URL of the instance.' + type: string + namedPorts: + description: '[Output Only] The named ports that belong to this instance + group.' + items: + $ref: '#/components/schemas/NamedPort' + type: array + status: + description: '[Output Only] The status of the instance.' + enum: + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED + type: string + type: object + InstancesAddResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be added to this instance. + items: + type: string + type: array + type: object + InstancesGetEffectiveFirewallsResponse: + properties: + firewallPolicys: + description: Effective firewalls from firewall policies. + items: + $ref: '#/components/schemas/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy' + type: array + firewalls: + description: Effective firewalls on the instance. + items: + $ref: '#/components/schemas/Firewall' + type: array + type: object + InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy: + properties: + displayName: + description: '[Output Only] Deprecated, please use short name instead. The + display name of the firewall policy.' + type: string + name: + description: '[Output Only] The name of the firewall policy.' + type: string + rules: + description: The rules that apply to the network. + items: + $ref: '#/components/schemas/FirewallPolicyRule' + type: array + shortName: + description: '[Output Only] The short name of the firewall policy.' + type: string + type: + description: '[Output Only] The type of the firewall policy.' + enum: + - HIERARCHY + - UNSPECIFIED + type: string + type: object + InstancesRemoveResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be removed from this instance. + items: + type: string + type: array + type: object + InstancesScopedList: + properties: + instances: + description: '[Output Only] A list of instances contained in this scope.' + items: + $ref: '#/components/schemas/Instance' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of instances 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InstancesSetLabelsRequest: + properties: + labelFingerprint: + description: Fingerprint of the previous set of labels for this resource, + used to prevent conflicts. Provide the latest fingerprint value when making + a request to add or change labels. + format: byte + type: string + labels: + additionalProperties: + type: string + type: object + type: object + InstancesSetMachineResourcesRequest: + properties: + guestAccelerators: + description: A list of the type and count of accelerator cards attached + to the instance. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + type: object + InstancesSetMachineTypeRequest: + properties: + machineType: + description: 'Full or partial URL of the machine type resource. See Machine + Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1' + type: string + type: object + InstancesSetMinCpuPlatformRequest: + properties: + minCpuPlatform: + description: Minimum cpu/platform this instance should be started at. + type: string + type: object + InstancesSetServiceAccountRequest: + properties: + email: + description: Email address of the service account. + type: string + scopes: + description: The list of scopes to be made available for this service account. + items: + type: string + type: array + type: object + InstancesStartWithEncryptionKeyRequest: + properties: + disks: + description: Array of disks associated with this instance that are protected + with a customer-supplied encryption key. In order to start the instance, + the disk url and its corresponding key must be provided. If the disk is + not protected with a customer-supplied encryption key it should not be + specified. + items: + $ref: '#/components/schemas/CustomerEncryptionKeyProtectedDisk' + type: array + type: object + Int64RangeMatch: + description: HttpRouteRuleMatch criteria for field values that must stay within + the specified integer range. + properties: + rangeEnd: + description: The end of the range (exclusive) in signed long integer format. + format: int64 + type: string + rangeStart: + description: The start of the range (inclusive) in signed long integer format. + format: int64 + type: string + type: object + Interconnect: + description: Represents an Interconnect resource. An Interconnect resource is + a dedicated connection between the GCP network and your on-premises network. + For more information, read the Dedicated Interconnect Overview. + properties: + adminEnabled: + 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 + circuitInfos: + description: '[Output Only] A list of CircuitInfo objects, that describe + the individual circuits in this LAG.' + items: + $ref: '#/components/schemas/InterconnectCircuitInfo' + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customerName: + description: Customer name, to put in the Letter of Authorization as the + party authorized to request a crossconnect. + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + expectedOutages: + description: '[Output Only] A list of outages expected for this Interconnect.' + items: + $ref: '#/components/schemas/InterconnectOutageNotification' + type: array + googleIpAddress: + description: '[Output Only] IP address configured on the Google side of + the Interconnect link. This can be used only for ping tests.' + type: string + googleReferenceId: + description: '[Output Only] Google reference ID to be used when raising + support tickets with Google or otherwise to debug backend connectivity + issues.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + interconnectAttachments: + description: '[Output Only] A list of the URLs of all InterconnectAttachments + configured to use this Interconnect.' + items: + type: string + type: array + interconnectType: + description: 'Type of interconnect, which can take one of the following + values: - PARTNER: A partner-managed interconnection shared between customers + though a partner. - DEDICATED: A dedicated physical interconnection with + the customer. Note that a value IT_PRIVATE has been deprecated in favor + of DEDICATED.' + enum: + - DEDICATED + - IT_PRIVATE + - PARTNER + type: string + kind: + default: compute#interconnect + description: '[Output Only] Type of the resource. Always compute#interconnect + for interconnects.' + type: string + linkType: + description: '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.' + enum: + - LINK_TYPE_ETHERNET_100G_LR + - LINK_TYPE_ETHERNET_10G_LR + type: string + location: + description: URL of the InterconnectLocation object that represents where + this connection is to be provisioned. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + nocContactEmail: + description: 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 Stackdriver logs alerting and Cloud Notifications. + type: string + operationalStatus: + description: '[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. ' + enum: + - OS_ACTIVE + - OS_UNPROVISIONED + type: string + peerIpAddress: + description: '[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.' + type: string + provisionedLinkCount: + description: '[Output Only] Number of links actually provisioned in this + interconnect.' + format: int32 + type: integer + requestedLinkCount: + description: Target number of physical links in the link bundle, as requested + by the customer. + format: int32 + type: integer + satisfiesPzs: + description: '[Output Only] Set to true if the resource satisfies the zone + separation organization policy constraints and false otherwise. Defaults + to false if the field is not present.' + type: boolean + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + state: + description: '[Output Only] The current state of Interconnect functionality, + which can take one of the following values: - ACTIVE: The Interconnect + is valid, turned up and ready to use. Attachments may be provisioned on + this Interconnect. - UNPROVISIONED: The Interconnect has not completed + turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: + The Interconnect is undergoing internal maintenance. No attachments may + be provisioned or updated on this Interconnect. ' + enum: + - ACTIVE + - UNPROVISIONED + type: string + type: object + InterconnectAttachment: + description: Represents an Interconnect Attachment (VLAN) resource. You can + use Interconnect attachments (VLANS) to connect your Virtual Private Cloud + networks to your on-premises networks through an Interconnect. For more information, + read Creating VLAN Attachments. + properties: + adminEnabled: + description: Determines whether this Attachment will carry packets. Not + present for PARTNER_PROVIDER. + type: boolean + bandwidth: + description: 'Provisioned bandwidth capacity for the interconnect attachment. + For attachments of type DEDICATED, the user can set the bandwidth. For + attachments of type PARTNER, the Google Partner that is operating the + interconnect must set the bandwidth. Output only for PARTNER type, mutable + for PARTNER_PROVIDER and DEDICATED, and can take one of the following + values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s + - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - + BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s + - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s ' + enum: + - BPS_100M + - BPS_10G + - BPS_1G + - BPS_200M + - BPS_20G + - BPS_2G + - BPS_300M + - BPS_400M + - BPS_500M + - BPS_50G + - BPS_50M + - BPS_5G + type: string + candidateSubnets: + description: Up to 16 candidate prefixes that can be used to restrict the + allocation of cloudRouterIpAddress and customerRouterIpAddress for this + attachment. All prefixes must be within link-local address space (169.254.0.0/16) + and must be /29 or shorter (/28, /27, etc). Google will attempt to select + an unused /29 from the supplied candidate prefix(es). The request will + fail if all possible /29s are in use on Google's edge. If not supplied, + Google will randomly select an unused /29 from all of link-local space. + items: + type: string + type: array + cloudRouterIpAddress: + description: '[Output Only] IPv4 address + prefix length to be configured + on Cloud Router Interface for this interconnect attachment.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customerRouterIpAddress: + description: '[Output Only] IPv4 address + prefix length to be configured + on the customer router subinterface for this interconnect attachment.' + type: string + dataplaneVersion: + description: '[Output Only] Dataplane version for this InterconnectAttachment.' + format: int32 + type: integer + description: + description: An optional description of this resource. + type: string + edgeAvailabilityDomain: + description: 'Desired availability domain for the attachment. Only available + for type PARTNER, at creation time, and can take one of the following + values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 + For improved reliability, customers should configure a pair of attachments, + one per availability domain. The selected availability domain will be + provided to the Partner via the pairing key, so that the provisioned circuit + will lie in the specified domain. If not specified, the value will default + to AVAILABILITY_DOMAIN_ANY.' + enum: + - AVAILABILITY_DOMAIN_1 + - AVAILABILITY_DOMAIN_2 + - AVAILABILITY_DOMAIN_ANY + type: string + encryption: + description: 'Indicates the user-supplied encryption option of this VLAN + attachment (interconnectAttachment). Can only be specified at attachment + creation for PARTNER or DEDICATED attachments. Possible values are: - + NONE - This is the default value, which means that the VLAN attachment + carries unencrypted traffic. VMs are able to send traffic to, or receive + traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries + only encrypted traffic that is encrypted by an IPsec device, such as an + HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic + to, or receive traffic from, such a VLAN attachment. To use *IPsec-encrypted + Cloud Interconnect*, the VLAN attachment must be created with this option. + Not currently available publicly. ' + enum: + - IPSEC + - NONE + type: string + googleReferenceId: + 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 + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + interconnect: + description: URL of the underlying Interconnect object that this attachment's + traffic will traverse through. + type: string + ipsecInternalAddresses: + description: 'A list of URLs of addresses that have been reserved for the + VLAN attachment. Used only for the VLAN attachment that has the encryption + option as IPSEC. The addresses must be regional internal IP address ranges. + When creating an HA VPN gateway over the VLAN attachment, if the attachment + is configured to use a regional internal IP address, then the VPN gateway''s + IP address is allocated from the IP address range specified here. For + example, if the HA VPN gateway''s interface 0 is paired to this VLAN attachment, + then a regional internal IP address for the VPN gateway interface 0 will + be allocated from the IP address specified for this VLAN attachment. If + this field is not specified when creating the VLAN attachment, then later + on when creating an HA VPN gateway on this VLAN attachment, the HA VPN + gateway''s IP address is allocated from the regional external IP address + pool. Not currently available publicly. ' + items: + type: string + type: array + kind: + default: compute#interconnectAttachment + description: '[Output Only] Type of the resource. Always compute#interconnectAttachment + for interconnect attachments.' + type: string + mtu: + description: Maximum Transmission Unit (MTU), in bytes, of packets passing + through this interconnect attachment. Only 1440 and 1500 are allowed. + If not specified, the value will default to 1440. + format: int32 + type: integer + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + operationalStatus: + description: '[Output Only] The current status of whether or not this interconnect + attachment is functional, which can take one of the following values: + - OS_ACTIVE: The attachment has been turned up and is ready to use. - + OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup + is not complete. ' + enum: + - OS_ACTIVE + - OS_UNPROVISIONED + type: string + pairingKey: + description: '[Output only for type PARTNER. Input only for PARTNER_PROVIDER. + Not present for DEDICATED]. The opaque identifier of an PARTNER attachment + used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"' + type: string + partnerAsn: + description: Optional BGP ASN for the router supplied by a Layer 3 Partner + if they configured BGP on behalf of the customer. Output only for PARTNER + type, input only for PARTNER_PROVIDER, not available for DEDICATED. + format: int64 + type: string + partnerMetadata: + $ref: '#/components/schemas/InterconnectAttachmentPartnerMetadata' + description: Informational metadata about Partner attachments from Partners + to display to customers. Output only for for PARTNER type, mutable for + PARTNER_PROVIDER, not available for DEDICATED. + privateInterconnectInfo: + $ref: '#/components/schemas/InterconnectAttachmentPrivateInfo' + description: '[Output Only] Information specific to an InterconnectAttachment. + This property is populated if the interconnect that this is attached to + is of type DEDICATED.' + region: + description: '[Output Only] URL of the region where the regional interconnect + attachment resides. You must specify this field as part of the HTTP request + URL. It is not settable as a field in the request body.' + type: string + router: + description: URL of the Cloud Router to be used for dynamic routing. This + router must be in the same region as this InterconnectAttachment. The + InterconnectAttachment will automatically connect the Interconnect to + the network & region within which the Cloud Router is configured. + type: string + satisfiesPzs: + description: '[Output Only] Set to true if the resource satisfies the zone + separation organization policy constraints and false otherwise. Defaults + to false if the field is not present.' + type: boolean + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + state: + description: '[Output Only] The current state of this attachment''s functionality. + Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, + PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values + PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used + for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state + can take one of the following values: - ACTIVE: The attachment has been + turned up and is ready to use. - UNPROVISIONED: The attachment is not + ready to use yet, because turnup is not complete. - PENDING_PARTNER: A + newly-created PARTNER attachment that has not yet been configured on the + Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the + process of provisioning after a PARTNER_PROVIDER attachment was created + that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER + attachment that is waiting for a customer to activate it. - DEFUNCT: The + attachment was deleted externally and is no longer functional. This could + be because the associated Interconnect was removed, or because the other + side of a Partner attachment was deleted. ' + enum: + - ACTIVE + - DEFUNCT + - PARTNER_REQUEST_RECEIVED + - PENDING_CUSTOMER + - PENDING_PARTNER + - STATE_UNSPECIFIED + - UNPROVISIONED + type: string + type: + description: 'The type of interconnect attachment this is, which can take + one of the following values: - DEDICATED: an attachment to a Dedicated + Interconnect. - PARTNER: an attachment to a Partner Interconnect, created + by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, + created by the partner. ' + enum: + - DEDICATED + - PARTNER + - PARTNER_PROVIDER + type: string + vlanTag8021q: + description: The IEEE 802.1Q VLAN tag for this attachment, in the range + 2-4094. Only specified at creation time. + format: int32 + type: integer + type: object + InterconnectAttachmentAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/InterconnectAttachmentsScopedList' + description: Name of the scope containing this set of interconnect attachments. + description: A list of InterconnectAttachmentsScopedList resources. + type: object + kind: + default: compute#interconnectAttachmentAggregatedList + description: '[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList + for aggregated lists of interconnect attachments.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectAttachmentList: + description: Response to the list request, and contains a list of interconnect + attachments. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InterconnectAttachment resources. + items: + $ref: '#/components/schemas/InterconnectAttachment' + type: array + kind: + default: compute#interconnectAttachmentList + description: '[Output Only] Type of resource. Always compute#interconnectAttachmentList + for lists of interconnect attachments.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectAttachmentPartnerMetadata: + description: Informational metadata about Partner attachments from Partners + to display to customers. These fields are propagated from PARTNER_PROVIDER + attachments to their corresponding PARTNER attachments. + properties: + interconnectName: + description: Plain text name of the Interconnect this attachment is connected + to, as displayed in the Partner's portal. For instance "Chicago 1". This + value may be validated to match approved Partner values. + type: string + partnerName: + description: Plain text name of the Partner providing this attachment. This + value may be validated to match approved Partner values. + type: string + portalUrl: + description: URL of the Partner's portal for this Attachment. Partners may + customise this to be a deep link to the specific resource on the Partner + portal. This value may be validated to match approved Partner values. + type: string + type: object + InterconnectAttachmentPrivateInfo: + description: Information for an interconnect attachment when this belongs to + an interconnect of type DEDICATED. + properties: + tag8021q: + description: '[Output Only] 802.1q encapsulation tag to be used for traffic + between Google and the customer, going to and from this network and region.' + format: uint32 + type: integer + type: object + InterconnectAttachmentsScopedList: + properties: + interconnectAttachments: + description: A list of interconnect attachments contained in this scope. + items: + $ref: '#/components/schemas/InterconnectAttachment' + type: array + warning: + description: Informational warning which replaces the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectCircuitInfo: + description: Describes a single physical circuit between the Customer and Google. + CircuitInfo objects are created by Google, so all fields are output only. + properties: + customerDemarcId: + description: Customer-side demarc ID for this circuit. + type: string + googleCircuitId: + description: Google-assigned unique ID for this circuit. Assigned at circuit + turn-up. + type: string + googleDemarcId: + description: Google-side demarc ID for this circuit. Assigned at circuit + turn-up and provided by Google to the customer in the LOA. + type: string + type: object + InterconnectDiagnostics: + description: Diagnostics information about interconnect, contains detailed and + current technical information about Google's side of the connection. + properties: + arpCaches: + description: 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. + items: + $ref: '#/components/schemas/InterconnectDiagnosticsARPEntry' + type: array + links: + description: A list of InterconnectDiagnostics.LinkStatus objects, describing + the status for each link on the Interconnect. + items: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkStatus' + type: array + macAddress: + description: The MAC address of the Interconnect's bundle interface. + type: string + type: object + InterconnectDiagnosticsARPEntry: + description: Describing the ARP neighbor entries seen on this link + properties: + ipAddress: + description: The IP address of this ARP neighbor. + type: string + macAddress: + description: The MAC address of this ARP neighbor. + type: string + type: object + InterconnectDiagnosticsLinkLACPStatus: + properties: + googleSystemId: + description: System ID of the port on Google's side of the LACP exchange. + type: string + neighborSystemId: + description: System ID of the port on the neighbor's side of the LACP exchange. + type: string + state: + description: '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. ' + enum: + - ACTIVE + - DETACHED + type: string + type: object + InterconnectDiagnosticsLinkOpticalPower: + properties: + state: + description: '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. ' + enum: + - HIGH_ALARM + - HIGH_WARNING + - LOW_ALARM + - LOW_WARNING + - OK + type: string + value: + description: Value of the current receiving or transmitting optical power, + read in dBm. Take a known good optical value, give it a 10% margin and + trigger warnings relative to that value. In general, a -7dBm warning and + a -11dBm alarm are good optical value estimates for most links. + format: float + type: number + type: object + InterconnectDiagnosticsLinkStatus: + properties: + arpCaches: + description: A list of InterconnectDiagnostics.ARPEntry objects, describing + the ARP neighbor entries seen on this link. This will be empty if the + link is bundled + items: + $ref: '#/components/schemas/InterconnectDiagnosticsARPEntry' + type: array + circuitId: + description: The unique ID for this link assigned during turn up by Google. + type: string + googleDemarc: + description: The Demarc address assigned by Google and provided in the LoA. + type: string + lacpStatus: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkLACPStatus' + receivingOpticalPower: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkOpticalPower' + description: An InterconnectDiagnostics.LinkOpticalPower object, describing + the current value and status of the received light level. + transmittingOpticalPower: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkOpticalPower' + description: An InterconnectDiagnostics.LinkOpticalPower object, describing + the current value and status of the transmitted light level. + type: object + InterconnectList: + description: Response to the list request, and contains a list of interconnects. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Interconnect resources. + items: + $ref: '#/components/schemas/Interconnect' + type: array + kind: + default: compute#interconnectList + description: '[Output Only] Type of resource. Always compute#interconnectList + for lists of interconnects.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectLocation: + description: 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. + properties: + address: + description: '[Output Only] The postal address of the Point of Presence, + each line in the address is separated by a newline character.' + type: string + availabilityZone: + 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 + city: + description: '[Output Only] Metropolitan area designator that indicates + which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, + Netherlands".' + type: string + continent: + description: '[Output Only] Continent for this location, which can take + one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA + - SOUTH_AMERICA ' + enum: + - AFRICA + - ASIA_PAC + - C_AFRICA + - C_ASIA_PAC + - C_EUROPE + - C_NORTH_AMERICA + - C_SOUTH_AMERICA + - EUROPE + - NORTH_AMERICA + - SOUTH_AMERICA + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: '[Output Only] An optional description of the resource.' + type: string + facilityProvider: + description: '[Output Only] The name of the provider for this facility (e.g., + EQUINIX).' + type: string + facilityProviderFacilityId: + description: '[Output Only] A provider-assigned Identifier for this facility + (e.g., Ashburn-DC1).' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#interconnectLocation + description: '[Output Only] Type of the resource. Always compute#interconnectLocation + for interconnect locations.' + type: string + name: + description: '[Output Only] Name of the resource.' + type: string + peeringdbFacilityId: + description: '[Output Only] The peeringdb identifier for this facility (corresponding + with a netfac type in peeringdb).' + type: string + regionInfos: + description: '[Output Only] A list of InterconnectLocation.RegionInfo objects, + that describe parameters pertaining to the relation between this InterconnectLocation + and various Google Cloud regions.' + items: + $ref: '#/components/schemas/InterconnectLocationRegionInfo' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of this InterconnectLocation, which + can take one of the following values: - CLOSED: The InterconnectLocation + is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: + The InterconnectLocation is available for provisioning new Interconnects. ' + enum: + - AVAILABLE + - CLOSED + type: string + supportsPzs: + description: '[Output Only] Set to true for locations that support physical + zone separation. Defaults to false if the field is not present.' + type: boolean + type: object + InterconnectLocationList: + description: Response to the list request, and contains a list of interconnect + locations. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InterconnectLocation resources. + items: + $ref: '#/components/schemas/InterconnectLocation' + type: array + kind: + default: compute#interconnectLocationList + description: '[Output Only] Type of resource. Always compute#interconnectLocationList + for lists of interconnect locations.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + InterconnectLocationRegionInfo: + description: Information about any potential InterconnectAttachments between + an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. + properties: + expectedRttMs: + description: Expected round-trip time in milliseconds, from this InterconnectLocation + to a VM in this region. + format: int64 + type: string + locationPresence: + description: Identifies the network presence of this location. + enum: + - GLOBAL + - LOCAL_REGION + - LP_GLOBAL + - LP_LOCAL_REGION + type: string + region: + description: URL for the region of this location. + type: string + type: object + InterconnectOutageNotification: + description: Description of a planned outage on this Interconnect. + properties: + affectedCircuits: + description: If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side + circuit IDs that will be affected. + items: + type: string + type: array + description: + description: A description about the purpose of the outage. + type: string + endTime: + description: Scheduled end time for the outage (milliseconds since Unix + epoch). + format: int64 + type: string + issueType: + description: 'Form this outage is expected to take, which can take one of + the following values: - OUTAGE: The Interconnect may be completely out + of service for some or all of the specified window. - PARTIAL_OUTAGE: + Some circuits comprising the Interconnect as a whole should remain up, + but with reduced bandwidth. Note that the versions of this enum prefixed + with "IT_" have been deprecated in favor of the unprefixed values.' + enum: + - IT_OUTAGE + - IT_PARTIAL_OUTAGE + - OUTAGE + - PARTIAL_OUTAGE + type: string + name: + description: Unique identifier for this outage notification. + type: string + source: + description: 'The party that generated this notification, which can take + the following value: - GOOGLE: this notification as generated by Google. + Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.' + enum: + - GOOGLE + - NSRC_GOOGLE + type: string + startTime: + description: Scheduled start time for the outage (milliseconds since Unix + epoch). + format: int64 + type: string + state: + description: 'State of this notification, which can take one of the following + values: - ACTIVE: This outage notification is active. The event could + be in the past, present, or future. See start_time and end_time for scheduling. + - CANCELLED: The outage associated with this notification was cancelled + before the outage was due to start. - COMPLETED: The outage associated + with this notification is complete. Note that the versions of this enum + prefixed with "NS_" have been deprecated in favor of the unprefixed values.' + enum: + - ACTIVE + - CANCELLED + - COMPLETED + - NS_ACTIVE + - NS_CANCELED + type: string + type: object + InterconnectsGetDiagnosticsResponse: + description: Response for the InterconnectsGetDiagnosticsRequest. + properties: + result: + $ref: '#/components/schemas/InterconnectDiagnostics' + 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. ' + properties: + chargesUseFee: + description: '[Output Only] Deprecated. This field no longer reflects whether + a license charges a usage fee.' + type: boolean + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional textual description of the resource; provided by + the client when the resource is created. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#license + description: '[Output Only] Type of resource. Always compute#license for + licenses.' + type: string + licenseCode: + description: '[Output Only] The unique code used to attach this license + to images, snapshots, and disks.' + format: uint64 + type: string + name: + description: Name of the resource. 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 + resourceRequirements: + $ref: '#/components/schemas/LicenseResourceRequirements' + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + transferable: + description: If false, licenses will not be copied from the source resource + when creating an image from a disk, disk from snapshot, or snapshot from + disk. + type: boolean + type: object + LicenseCode: + description: 'Represents a License Code resource. A License Code is a unique + identifier used to represent a license resource. *Caution* This resource is + intended for use only by third-party partners who are creating Cloud Marketplace + images. ' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: '[Output Only] Description of this License Code.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#licenseCode + description: '[Output Only] Type of resource. Always compute#licenseCode + for licenses.' + type: string + licenseAlias: + description: '[Output Only] URL and description aliases of Licenses with + the same License Code.' + items: + $ref: '#/components/schemas/LicenseCodeLicenseAlias' + type: array + name: + description: '[Output Only] Name of the resource. The name is 1-20 characters + long and must be a valid 64 bit integer.' + pattern: '[0-9]{0,20}?' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + state: + description: '[Output Only] Current state of this License Code.' + enum: + - DISABLED + - ENABLED + - RESTRICTED + - STATE_UNSPECIFIED + - TERMINATED + type: string + transferable: + description: '[Output Only] If true, the license will remain attached when + creating images or snapshots from disks. Otherwise, the license is not + transferred.' + type: boolean + type: object + LicenseCodeLicenseAlias: + properties: + description: + description: '[Output Only] Description of this License Code.' + type: string + selfLink: + description: '[Output Only] URL of license corresponding to this License + Code.' + type: string + type: object + LicenseResourceCommitment: + description: Commitment for a particular license resource. + properties: + amount: + description: The number of licenses purchased. + format: int64 + type: string + coresPerLicense: + description: Specifies the core range of the instance for which this license + applies. + type: string + license: + description: Any applicable license URI. + type: string + type: object + LicenseResourceRequirements: + properties: + minGuestCpuCount: + description: Minimum number of guest cpus required to use the Instance. + Enforced at Instance creation and Instance start. + format: int32 + type: integer + minMemoryMb: + description: Minimum memory required to use the Instance. Enforced at Instance + creation and Instance start. + format: int32 + type: integer + type: object + LicensesListResponse: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of License resources. + items: + $ref: '#/components/schemas/License' + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + LocalDisk: + properties: + diskCount: + description: Specifies the number of such disks. + format: int32 + type: integer + diskSizeGb: + description: Specifies the size of the disk in base-2 GB. + format: int32 + type: integer + diskType: + description: 'Specifies the desired disk type on the node. This disk type + must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, + this should be the name of the disk type and not its URL.' + type: string + type: object + LocationPolicy: + description: Configuration for location policy among multiple possible locations + (e.g. preferences for zone selection among zones in a single region). + properties: + locations: + additionalProperties: + $ref: '#/components/schemas/LocationPolicyLocation' + description: Location configurations mapped by location name. Currently + only zone names are supported and must be represented as valid internal + URLs, such as zones/us-central1-a. + type: object + type: object + LocationPolicyLocation: + properties: + preference: + description: 'Preference for a given location: ALLOW or DENY.' + enum: + - ALLOW + - DENY + - PREFERENCE_UNSPECIFIED + type: string + type: object + LogConfig: + description: This is deprecated and has no effect. Do not use. + properties: + cloudAudit: + $ref: '#/components/schemas/LogConfigCloudAuditOptions' + description: This is deprecated and has no effect. Do not use. + counter: + $ref: '#/components/schemas/LogConfigCounterOptions' + description: This is deprecated and has no effect. Do not use. + dataAccess: + $ref: '#/components/schemas/LogConfigDataAccessOptions' + description: This is deprecated and has no effect. Do not use. + type: object + LogConfigCloudAuditOptions: + description: This is deprecated and has no effect. Do not use. + properties: + authorizationLoggingOptions: + $ref: '#/components/schemas/AuthorizationLoggingOptions' + description: This is deprecated and has no effect. Do not use. + logName: + description: This is deprecated and has no effect. Do not use. + enum: + - ADMIN_ACTIVITY + - DATA_ACCESS + - UNSPECIFIED_LOG_NAME + type: string + type: object + LogConfigCounterOptions: + description: This is deprecated and has no effect. Do not use. + properties: + customFields: + description: This is deprecated and has no effect. Do not use. + items: + $ref: '#/components/schemas/LogConfigCounterOptionsCustomField' + type: array + field: + description: This is deprecated and has no effect. Do not use. + type: string + metric: + description: This is deprecated and has no effect. Do not use. + type: string + type: object + LogConfigCounterOptionsCustomField: + description: This is deprecated and has no effect. Do not use. + properties: + name: + description: This is deprecated and has no effect. Do not use. + type: string + value: + description: This is deprecated and has no effect. Do not use. + type: string + type: object + LogConfigDataAccessOptions: + description: This is deprecated and has no effect. Do not use. + properties: + logMode: + description: This is deprecated and has no effect. Do not use. + enum: + - LOG_FAIL_CLOSED + - LOG_MODE_UNSPECIFIED + type: string + type: object + MachineType: + description: Represents a Machine Type resource. You can use specific machine + types for your VM instances based on performance and pricing requirements. + For more information, read Machine Types. + properties: + accelerators: + description: '[Output Only] A list of accelerator configurations assigned + to this machine type.' + items: + properties: + guestAcceleratorCount: + description: Number of accelerator cards exposed to the guest. + format: int32 + type: integer + guestAcceleratorType: + description: The accelerator type resource name, not a full URL, e.g. + 'nvidia-tesla-k80'. + type: string + type: object + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + machine type. Only applicable if the machine type is unavailable.' + description: + description: '[Output Only] An optional textual description of the resource.' + type: string + guestCpus: + description: '[Output Only] The number of virtual CPUs that are available + to the instance.' + format: int32 + type: integer + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + imageSpaceGb: + description: '[Deprecated] This property is deprecated and will never be + populated with any relevant values.' + format: int32 + type: integer + isSharedCpu: + description: '[Output Only] Whether this machine type has a shared CPU. + See Shared-core machine types for more information.' + type: boolean + kind: + default: compute#machineType + description: '[Output Only] The type of the resource. Always compute#machineType + for machine types.' + type: string + maximumPersistentDisks: + description: '[Output Only] Maximum persistent disks allowed.' + format: int32 + type: integer + maximumPersistentDisksSizeGb: + description: '[Output Only] Maximum total persistent disks size (GB) allowed.' + format: int64 + type: string + memoryMb: + description: '[Output Only] The amount of physical memory available to the + instance, defined in MB.' + format: int32 + type: integer + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + scratchDisks: + description: '[Output Only] A list of extended scratch disks assigned to + the instance.' + items: + properties: + diskGb: + description: Size of the scratch disk, defined in GB. + format: int32 + type: integer + type: object + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + zone: + description: '[Output Only] The name of the zone where the machine type + resides, such as us-central1-a.' + type: string + type: object + MachineTypeAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/MachineTypesScopedList' + description: '[Output Only] Name of the scope containing this set of machine + types.' + description: A list of MachineTypesScopedList resources. + type: object + kind: + default: compute#machineTypeAggregatedList + description: '[Output Only] Type of resource. Always compute#machineTypeAggregatedList + for aggregated lists of machine types.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + MachineTypeList: + description: Contains a list of machine types. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of MachineType resources. + items: + $ref: '#/components/schemas/MachineType' + type: array + kind: + default: compute#machineTypeList + description: '[Output Only] Type of resource. Always compute#machineTypeList + for lists of machine types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + MachineTypesScopedList: + properties: + machineTypes: + description: '[Output Only] A list of machine types contained in this scope.' + items: + $ref: '#/components/schemas/MachineType' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + machine types 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ManagedInstance: + description: A Managed Instance resource. + properties: + currentAction: + description: '[Output Only] The current action that the managed instance + group has scheduled for the instance. Possible values: - NONE The instance + is running, and the managed instance group does not have any scheduled + actions for this instance. - CREATING The managed instance group is creating + this instance. If the group fails to create this instance, it will try + again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance + group is attempting to create this instance only once. If the group fails + to create this instance, it does not try again and the group''s targetSize + value is decreased instead. - RECREATING The managed instance group is + recreating this instance. - DELETING The managed instance group is permanently + deleting this instance. - ABANDONING The managed instance group is abandoning + this instance. The instance will be removed from the instance group and + from any target pools that are associated with this group. - RESTARTING + The managed instance group is restarting the instance. - REFRESHING The + managed instance group is applying configuration changes to the instance + without stopping it. For example, the group can update the target pool + list for an instance without stopping that instance. - VERIFYING The managed + instance group has created the instance and it is in the process of being + verified. ' + enum: + - ABANDONING + - CREATING + - CREATING_WITHOUT_RETRIES + - DELETING + - NONE + - RECREATING + - REFRESHING + - RESTARTING + - VERIFYING + type: string + id: + description: '[Output only] The unique identifier for this resource. This + field is empty when instance does not exist.' + format: uint64 + type: string + instance: + description: '[Output Only] The URL of the instance. The URL can exist even + if the instance has not yet been created.' + type: string + instanceHealth: + description: '[Output Only] Health state of the instance per health-check.' + items: + $ref: '#/components/schemas/ManagedInstanceInstanceHealth' + type: array + instanceStatus: + description: '[Output Only] The status of the instance. This field is empty + when the instance does not exist.' + enum: + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED + type: string + lastAttempt: + $ref: '#/components/schemas/ManagedInstanceLastAttempt' + description: '[Output Only] Information about the last attempt to create + or delete the instance.' + preservedStateFromConfig: + $ref: '#/components/schemas/PreservedState' + description: '[Output Only] Preserved state applied from per-instance config + for this instance.' + preservedStateFromPolicy: + $ref: '#/components/schemas/PreservedState' + description: '[Output Only] Preserved state generated based on stateful + policy for this instance.' + version: + $ref: '#/components/schemas/ManagedInstanceVersion' + description: '[Output Only] Intended version of this instance.' + type: object + ManagedInstanceInstanceHealth: + properties: + detailedHealthState: + description: '[Output Only] The current detailed instance health state.' + enum: + - DRAINING + - HEALTHY + - TIMEOUT + - UNHEALTHY + - UNKNOWN + type: string + healthCheck: + description: '[Output Only] The URL for the health check that verifies whether + the instance is healthy.' + type: string + type: object + ManagedInstanceLastAttempt: + properties: + errors: + description: '[Output Only] Encountered errors during the last attempt to + create or delete the instance.' + 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 + 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 + ManagedInstanceVersion: + properties: + instanceTemplate: + description: '[Output Only] The intended template of the instance. This + field is empty when current_action is one of { DELETING, ABANDONING }.' + type: string + name: + description: '[Output Only] Name of the version.' + type: string + type: object + Metadata: + description: A metadata key/value entry. + properties: + fingerprint: + description: Specifies a fingerprint for this request, which is essentially + a hash of the metadata's contents and used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update metadata. You must always provide an + up-to-date fingerprint hash in order to update or change metadata, otherwise + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the resource. + format: byte + type: string + items: + description: Array of key/value pairs. The total size of all keys and values + must be less than 512 KB. + items: + description: Metadata + properties: + key: + description: 'Key for the metadata entry. Keys must conform to the + following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in + length. This is reflected as part of a URL in the metadata server. + Additionally, to avoid ambiguity, keys must not conflict with any + other metadata keys for the project.' + pattern: '[a-zA-Z0-9-_]{1,128}' + type: string + value: + description: Value for the metadata entry. These are free-form strings, + and only have meaning as interpreted by the image running in the + instance. The only restriction placed on values is that their size + must be less than or equal to 262144 bytes (256 KiB). + type: string + type: object + type: array + kind: + default: compute#metadata + description: '[Output Only] Type of the resource. Always compute#metadata + for metadata.' + type: string + type: object + MetadataFilter: + description: 'Opaque filter criteria used by loadbalancers to restrict routing + configuration to a limited set of loadbalancing proxies. Proxies and sidecars + involved in loadbalancing would typically present metadata to the loadbalancers + which need to match criteria specified here. If a match takes place, the relevant + configuration is made available to those proxies. For each metadataFilter + in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one + of the filterLabels must match the corresponding label provided in the metadata. + If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels + must match with corresponding labels provided in the metadata. An example + for using metadataFilters would be: if loadbalancing involves Envoys, they + will only receive routing configuration when values in metadataFilters match + values supplied in of their XDS requests to loadbalancers.' + properties: + filterLabels: + description: The list of label value pairs that must match labels in the + provided metadata based on filterMatchCriteria This list must not be empty + and can have at the most 64 entries. + items: + $ref: '#/components/schemas/MetadataFilterLabelMatch' + type: array + filterMatchCriteria: + description: 'Specifies how individual filterLabel matches within the list + of filterLabels contribute towards the overall metadataFilter match. Supported + values are: - MATCH_ANY: At least one of the filterLabels must have a + matching label in the provided metadata. - MATCH_ALL: All filterLabels + must have matching labels in the provided metadata. ' + enum: + - MATCH_ALL + - MATCH_ANY + - NOT_SET + type: string + type: object + MetadataFilterLabelMatch: + description: MetadataFilter label name value pairs that are expected to match + corresponding labels presented as metadata to the loadbalancer. + properties: + name: + description: Name of metadata label. The name can have a maximum length + of 1024 characters and must be at least 1 character long. + type: string + value: + description: The value of the label must match the specified value. value + can have a maximum length of 1024 characters. + type: string + type: object + NamedPort: + description: 'The named port. For example: <"http", 80>.' + properties: + name: + description: The name for this named port. The name must be 1-63 characters + long, and comply with RFC1035. + type: string + port: + description: The port number, which can be a value between 1 and 65535. + format: int32 + type: integer + type: object + Network: + description: Represents a VPC Network resource. Networks connect resources to + each other and to the internet. For more information, read Virtual Private + Cloud (VPC) Network. + properties: + IPv4Range: + 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 + autoCreateSubnetworks: + description: Must be set to create a VPC network. If not set, a legacy network + is created. When set to true, the VPC network is created in auto mode. + When set to false, the VPC network is created in custom mode. An auto + mode VPC network starts with one subnet per region. Each subnet has a + predetermined range as described in Auto mode VPC network IP ranges. For + custom mode VPC networks, you can add subnets using the subnetworks insert + method. + type: boolean + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this field + when you create the resource. + type: string + gatewayIPv4: + description: '[Output Only] The gateway address for default routing out + of the network, selected by GCP.' + pattern: '[0-9]{1,3}(?:\.[0-9]{1,3}){3}' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#network + description: '[Output Only] Type of the resource. Always compute#network + for networks.' + type: string + mtu: + description: Maximum Transmission Unit in bytes. The minimum value for this + field is 1460 and the maximum value is 1500 bytes. If unspecified, defaults + to 1460. + format: int32 + type: integer + name: + description: 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])?`. The first character must be a + lowercase letter, and all following characters (except for the last character) + must be a dash, lowercase letter, or digit. The last character must be + a lowercase letter or digit. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + peerings: + description: '[Output Only] A list of network peerings for the resource.' + items: + $ref: '#/components/schemas/NetworkPeering' + type: array + routingConfig: + $ref: '#/components/schemas/NetworkRoutingConfig' + description: The network-level routing configuration for this network. Used + by Cloud Router to determine what type of network-wide routing behavior + to enforce. + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + subnetworks: + description: '[Output Only] Server-defined fully-qualified URLs for all + subnetworks in this VPC network.' + items: + type: string + type: array + type: object + NetworkEndpoint: + description: The network endpoint. + properties: + annotations: + additionalProperties: + type: string + description: Metadata defined as annotations on the network endpoint. + type: object + fqdn: + description: Optional fully qualified domain name of network endpoint. This + can only be specified when NetworkEndpointGroup.network_endpoint_type + is NON_GCP_FQDN_PORT. + type: string + instance: + description: 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. + type: string + ipAddress: + description: 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. + type: string + port: + description: Optional port number of network endpoint. If not specified, + the defaultPort for the network endpoint group will be used. + format: int32 + type: integer + type: object + NetworkEndpointGroup: + description: Represents a collection of network endpoints. A network endpoint + group (NEG) defines how a set of endpoints should be reached, whether they + are reachable, and where they are located. For more information about using + NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting + up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless + NEGs. + properties: + annotations: + additionalProperties: + type: string + description: Metadata defined as annotations on the network endpoint group. + type: object + appEngine: + $ref: '#/components/schemas/NetworkEndpointGroupAppEngine' + description: Only valid when networkEndpointType is "SERVERLESS". Only one + of cloudRun, appEngine or cloudFunction may be set. + cloudFunction: + $ref: '#/components/schemas/NetworkEndpointGroupCloudFunction' + description: Only valid when networkEndpointType is "SERVERLESS". Only one + of cloudRun, appEngine or cloudFunction may be set. + cloudRun: + $ref: '#/components/schemas/NetworkEndpointGroupCloudRun' + description: Only valid when networkEndpointType is "SERVERLESS". Only one + of cloudRun, appEngine or cloudFunction may be set. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + defaultPort: + description: The default port used if the port number is not specified in + the network endpoint. + format: int32 + type: integer + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#networkEndpointGroup + description: '[Output Only] Type of the resource. Always compute#networkEndpointGroup + for network endpoint group.' + type: string + name: + description: 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. + type: string + network: + description: The URL of the network to which all network endpoints in the + NEG belong. Uses "default" project network if unspecified. + type: string + networkEndpointType: + description: Type of network endpoints in this network endpoint group. Can + be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, + INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + enum: + - GCE_VM_IP + - GCE_VM_IP_PORT + - INTERNET_FQDN_PORT + - INTERNET_IP_PORT + - NON_GCP_PRIVATE_IP_PORT + - SERVERLESS + type: string + region: + description: '[Output Only] The URL of the region where the network endpoint + group is located.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + size: + description: '[Output only] Number of network endpoints in the network endpoint + group.' + format: int32 + type: integer + subnetwork: + description: Optional URL of the subnetwork to which all network endpoints + in the NEG belong. + type: string + zone: + description: '[Output Only] The URL of the zone where the network endpoint + group is located.' + type: string + type: object + NetworkEndpointGroupAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/NetworkEndpointGroupsScopedList' + description: The name of the scope that contains this set of network endpoint + groups. + description: A list of NetworkEndpointGroupsScopedList resources. + type: object + kind: + default: compute#networkEndpointGroupAggregatedList + description: '[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList + for aggregated lists of network endpoint groups.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkEndpointGroupAppEngine: + description: 'Configuration for an App Engine network endpoint group (NEG). + The service is optional, may be provided explicitly or in the URL mask. The + version is optional and can only be provided explicitly or in the URL mask + when service is present. Note: App Engine service must be in the same project + and located in the same region as the Serverless NEG.' + properties: + service: + description: 'Optional serving service. The service name is case-sensitive + and must be 1-63 characters long. Example value: "default", "my-service".' + type: string + urlMask: + description: A template to parse service and version fields from a request + URL. URL mask allows for routing to multiple App Engine services without + having to create multiple Network Endpoint Groups and backend services. + For example, the request URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" + can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". + The URL mask will parse them to { service = "foo1", version = "v1" } and + { service = "foo1", version = "v2" } respectively. + type: string + version: + description: 'Optional serving version. The version name is case-sensitive + and must be 1-100 characters long. Example value: "v1", "v2".' + type: string + type: object + NetworkEndpointGroupCloudFunction: + description: 'Configuration for a Cloud Function network endpoint group (NEG). + The function must be provided explicitly or in the URL mask. Note: Cloud Function + must be in the same project and located in the same region as the Serverless + NEG.' + properties: + function: + description: 'A user-defined name of the Cloud Function. The function name + is case-sensitive and must be 1-63 characters long. Example value: "func1".' + type: string + urlMask: + description: A template to parse function field from a request URL. URL + mask allows for routing to multiple Cloud Functions without having to + create multiple Network Endpoint Groups and backend services. For example, + request URLs " mydomain.com/function1" and "mydomain.com/function2" can + be backed by the same Serverless NEG with URL mask "/". The URL mask will + parse them to { function = "function1" } and { function = "function2" + } respectively. + type: string + type: object + NetworkEndpointGroupCloudRun: + description: 'Configuration for a Cloud Run network endpoint group (NEG). The + service must be provided explicitly or in the URL mask. The tag is optional, + may be provided explicitly or in the URL mask. Note: Cloud Run service must + be in the same project and located in the same region as the Serverless NEG.' + properties: + service: + description: 'Cloud Run service is the main resource of Cloud Run. The service + must be 1-63 characters long, and comply with RFC1035. Example value: + "run-service".' + type: string + tag: + description: 'Optional Cloud Run tag represents the "named-revision" to + provide additional fine-grained traffic routing information. The tag must + be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010".' + type: string + urlMask: + description: A template to parse service and tag fields from a request URL. + URL mask allows for routing to multiple Run services without having to + create multiple network endpoint groups and backend services. For example, + request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be + backed by the same Serverless Network Endpoint Group (NEG) with URL mask + ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" + } and { service="bar2", tag="foo2" } respectively. + type: string + type: object + NetworkEndpointGroupList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NetworkEndpointGroup resources. + items: + $ref: '#/components/schemas/NetworkEndpointGroup' + type: array + kind: + default: compute#networkEndpointGroupList + description: '[Output Only] The resource type, which is always compute#networkEndpointGroupList + for network endpoint 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkEndpointGroupsAttachEndpointsRequest: + properties: + networkEndpoints: + description: The list of network endpoints to be attached. + items: + $ref: '#/components/schemas/NetworkEndpoint' + type: array + type: object + NetworkEndpointGroupsDetachEndpointsRequest: + properties: + networkEndpoints: + description: The list of network endpoints to be detached. + items: + $ref: '#/components/schemas/NetworkEndpoint' + type: array + type: object + NetworkEndpointGroupsListEndpointsRequest: + properties: + healthStatus: + description: Optional query parameter for showing the health status of each + network endpoint. Valid options are SKIP or SHOW. If you don't specify + this parameter, the health status of network endpoints will not be provided. + enum: + - SHOW + - SKIP + type: string + type: object + NetworkEndpointGroupsListNetworkEndpoints: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NetworkEndpointWithHealthStatus resources. + items: + $ref: '#/components/schemas/NetworkEndpointWithHealthStatus' + type: array + kind: + default: compute#networkEndpointGroupsListNetworkEndpoints + description: '[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints + for the list of network endpoints in the specified network endpoint group.' + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkEndpointGroupsScopedList: + properties: + networkEndpointGroups: + description: '[Output Only] The list of network endpoint groups that are + contained in this scope.' + items: + $ref: '#/components/schemas/NetworkEndpointGroup' + type: array + warning: + description: '[Output Only] An informational warning that replaces the list + of network endpoint groups 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkEndpointWithHealthStatus: + properties: + healths: + description: '[Output only] The health status of network endpoint;' + items: + $ref: '#/components/schemas/HealthStatusForNetworkEndpoint' + type: array + networkEndpoint: + $ref: '#/components/schemas/NetworkEndpoint' + description: '[Output only] The network endpoint;' + type: object + NetworkInterface: + description: A network interface resource attached to an instance. + properties: + accessConfigs: + description: An array of configurations for this interface. Currently, only + one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs + specified, then this instance will have no external internet access. + items: + $ref: '#/components/schemas/AccessConfig' + type: array + aliasIpRanges: + description: An array of alias IP ranges for this network interface. You + can only specify this field for network interfaces in VPC networks. + items: + $ref: '#/components/schemas/AliasIpRange' + type: array + fingerprint: + description: Fingerprint hash of contents stored in this network interface. + This field will be ignored when inserting an Instance or adding a NetworkInterface. + An up-to-date fingerprint must be provided in order to update the NetworkInterface. + The request will fail with error 400 Bad Request if the fingerprint is + not provided, or 412 Precondition Failed if the fingerprint is out of + date. + format: byte + type: string + ipv6AccessConfigs: + description: An array of IPv6 access configurations for this interface. + Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If + there is no ipv6AccessConfig specified, then this instance will have no + external IPv6 Internet access. + items: + $ref: '#/components/schemas/AccessConfig' + type: array + ipv6AccessType: + description: '[Output Only] One of EXTERNAL, INTERNAL to indicate whether + the IP can be accessed from the Internet. This field is always inherited + from its subnetwork. Valid only if stackType is IPV4_IPV6.' + enum: + - EXTERNAL + - UNSPECIFIED_IPV6_ACCESS_TYPE + type: string + ipv6Address: + description: '[Output Only] An IPv6 internal network address for this network + interface.' + type: string + kind: + default: compute#networkInterface + description: '[Output Only] Type of the resource. Always compute#networkInterface + for network interfaces.' + type: string + name: + description: '[Output Only] The name of the network interface, which is + generated by the server. For network devices, these are eth0, eth1, etc.' + type: string + network: + description: 'URL of the network resource for this instance. When creating + an instance, if neither the network nor the subnetwork is specified, the + default network global/networks/default is used; if the network is not + specified but the subnetwork is specified, the network is inferred. If + you specify this property, you can specify the network as a full or partial + URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ + network - projects/project/global/networks/network - global/networks/default ' + type: string + networkIP: + description: An IPv4 internal IP address to assign to the instance for this + network interface. If not specified by the user, an unused internal IP + is assigned by the system. + type: string + nicType: + description: The type of vNIC to be used on this interface. This may be + gVNIC or VirtioNet. + enum: + - GVNIC + - UNSPECIFIED_NIC_TYPE + - VIRTIO_NET + type: string + queueCount: + description: The networking queue count that's specified by users for the + network interface. Both Rx and Tx queues will be set to this number. It'll + be empty if not specified by the users. + format: int32 + type: integer + stackType: + description: The stack type for this network interface to identify whether + the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be + used. This field can be both set at instance creation and update network + interface operations. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - UNSPECIFIED_STACK_TYPE + type: string + subnetwork: + description: 'The URL of the Subnetwork resource for this instance. If the + network resource is in legacy mode, do not specify this field. If the + network is in auto subnet mode, specifying the subnetwork is optional. + If the network is in custom subnet mode, specifying the subnetwork is + required. If you specify this field, you can specify the subnetwork as + a full or partial URL. For example, the following are all valid URLs: + - https://www.googleapis.com/compute/v1/projects/project/regions/region + /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ' + type: string + type: object + NetworkList: + description: Contains a list of networks. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Network resources. + items: + $ref: '#/components/schemas/Network' + type: array + kind: + default: compute#networkList + description: '[Output Only] Type of resource. Always compute#networkList + for lists of networks.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NetworkPeering: + description: A network peering attached to a network resource. The message includes + the peering name, peer network, peering state, and a flag indicating whether + Google Compute Engine should automatically create routes for the peering. + properties: + autoCreateRoutes: + description: This field will be deprecated soon. Use the exchange_subnet_routes + field instead. Indicates whether full mesh connectivity is created and + managed automatically between peered networks. Currently this field should + always be true since Google Compute Engine will automatically create and + manage subnetwork routes between two networks when peering state is ACTIVE. + type: boolean + exchangeSubnetRoutes: + description: Indicates whether full mesh connectivity is created and managed + automatically between peered networks. Currently this field should always + be true since Google Compute Engine will automatically create and manage + subnetwork routes between two networks when peering state is ACTIVE. + type: boolean + exportCustomRoutes: + description: Whether to export the custom routes to peer network. + type: boolean + exportSubnetRoutesWithPublicIp: + description: Whether subnet routes with public IP range are exported. The + default value is true, all subnet routes are exported. IPv4 special-use + ranges are always exported to peers and are not controlled by this field. + type: boolean + importCustomRoutes: + description: Whether to import the custom routes from peer network. + type: boolean + importSubnetRoutesWithPublicIp: + description: Whether subnet routes with public IP range are imported. The + default value is false. IPv4 special-use ranges are always imported from + peers and are not controlled by this field. + type: boolean + name: + description: Name of this peering. Provided by the client when the peering + is created. The name must comply with RFC1035. Specifically, the name + must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. + The first character must be a lowercase letter, and all the following + characters must be a dash, lowercase letter, or digit, except the last + character, which cannot be a dash. + type: string + network: + description: The URL of the peer network. It can be either full URL or partial + URL. The peer network may belong to a different project. If the partial + URL does not contain project, it is assumed that the peer network is in + the same project as the current network. + type: string + peerMtu: + description: Maximum Transmission Unit in bytes. + format: int32 + type: integer + state: + description: '[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. + The peering is `ACTIVE` when there''s a matching configuration in the + peer network.' + enum: + - ACTIVE + - INACTIVE + type: string + stateDetails: + description: '[Output Only] Details about the current state of the peering.' + type: string + type: object + NetworkRoutingConfig: + description: A routing configuration attached to a network resource. The message + includes the list of routers associated with the network, and a flag indicating + the type of routing behavior to enforce network-wide. + properties: + routingMode: + description: The network-wide routing mode to use. If set to REGIONAL, this + network's Cloud Routers will only advertise routes with subnets of this + network in the same region as the router. If set to GLOBAL, this network's + Cloud Routers will advertise routes with all subnets of this network, + across regions. + enum: + - GLOBAL + - REGIONAL + type: string + type: object + NetworksAddPeeringRequest: + properties: + autoCreateRoutes: + description: This field will be deprecated soon. Use exchange_subnet_routes + in network_peering instead. Indicates whether full mesh connectivity is + created and managed automatically between peered networks. Currently this + field should always be true since Google Compute Engine will automatically + create and manage subnetwork routes between two networks when peering + state is ACTIVE. + type: boolean + name: + description: Name of the peering, which should conform to RFC1035. + type: string + networkPeering: + $ref: '#/components/schemas/NetworkPeering' + description: Network peering parameters. In order to specify route policies + for peering using import and export custom routes, you must specify all + peering related parameters (name, peer network, exchange_subnet_routes) + in the network_peering field. The corresponding fields in NetworksAddPeeringRequest + will be deprecated soon. + peerNetwork: + description: URL of the peer network. It can be either full URL or partial + URL. The peer network may belong to a different project. If the partial + URL does not contain project, it is assumed that the peer network is in + the same project as the current network. + type: string + type: object + NetworksGetEffectiveFirewallsResponse: + properties: + firewallPolicys: + description: Effective firewalls from firewall policy. + items: + $ref: '#/components/schemas/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy' + type: array + firewalls: + description: Effective firewalls on the network. + items: + $ref: '#/components/schemas/Firewall' + type: array + type: object + NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy: + properties: + displayName: + description: '[Output Only] Deprecated, please use short name instead. The + display name of the firewall policy.' + type: string + name: + description: '[Output Only] The name of the firewall policy.' + type: string + rules: + description: The rules that apply to the network. + items: + $ref: '#/components/schemas/FirewallPolicyRule' + type: array + shortName: + description: '[Output Only] The short name of the firewall policy.' + type: string + type: + description: '[Output Only] The type of the firewall policy.' + enum: + - HIERARCHY + - NETWORK + - UNSPECIFIED + type: string + type: object + NetworksRemovePeeringRequest: + properties: + name: + description: Name of the peering, which should conform to RFC1035. + type: string + type: object + NetworksUpdatePeeringRequest: + properties: + networkPeering: + $ref: '#/components/schemas/NetworkPeering' + type: object + NodeGroup: + description: Represents a sole-tenant Node Group resource. A sole-tenant node + is a physical server that is dedicated to hosting VM instances only for your + specific project. Use sole-tenant nodes to keep your instances physically + separated from instances in other projects, or to group your instances together + on the same host hardware. For more information, read Sole-tenant nodes. + properties: + autoscalingPolicy: + $ref: '#/components/schemas/NodeGroupAutoscalingPolicy' + description: Specifies how autoscaling should behave. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#nodeGroup + description: '[Output Only] The type of the resource. Always compute#nodeGroup + for node group.' + type: string + locationHint: + description: An opaque location hint used to place the Node close to other + resources. This field is for use by internal tools that use the public + API. The location hint here on the NodeGroup overrides any location_hint + present in the NodeTemplate. + type: string + maintenancePolicy: + description: 'Specifies how to handle instances when a node in the group + undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. + The default value is DEFAULT. For more information, see Maintenance policies.' + enum: + - DEFAULT + - MAINTENANCE_POLICY_UNSPECIFIED + - MIGRATE_WITHIN_NODE_GROUP + - RESTART_IN_PLACE + type: string + maintenanceWindow: + $ref: '#/components/schemas/NodeGroupMaintenanceWindow' + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + nodeTemplate: + description: URL of the node template to create the node group from. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + size: + description: '[Output Only] The total number of nodes in the node group.' + format: int32 + type: integer + status: + enum: + - CREATING + - DELETING + - INVALID + - READY + type: string + zone: + description: '[Output Only] The name of the zone where the node group resides, + such as us-central1-a.' + type: string + type: object + NodeGroupAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/NodeGroupsScopedList' + description: '[Output Only] Name of the scope containing this set of node + groups.' + description: A list of NodeGroupsScopedList resources. + type: object + kind: + default: compute#nodeGroupAggregatedList + description: '[Output Only] Type of resource.Always compute#nodeGroupAggregatedList + for aggregated lists of node groups.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeGroupAutoscalingPolicy: + properties: + maxNodes: + description: The maximum number of nodes that the group should have. Must + be set if autoscaling is enabled. Maximum value allowed is 100. + format: int32 + type: integer + minNodes: + description: The minimum number of nodes that the group should have. + format: int32 + type: integer + mode: + description: 'The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. + For more information, see Autoscaler modes.' + enum: + - MODE_UNSPECIFIED + - false + - true + - ONLY_SCALE_OUT + type: string + type: object + NodeGroupList: + description: Contains a list of nodeGroups. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NodeGroup resources. + items: + $ref: '#/components/schemas/NodeGroup' + type: array + kind: + default: compute#nodeGroupList + description: '[Output Only] Type of resource.Always compute#nodeGroupList + for lists of node groups.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeGroupMaintenanceWindow: + description: Time window specified for daily maintenance operations. GCE's internal + maintenance will be performed within this window. + properties: + maintenanceDuration: + $ref: '#/components/schemas/Duration' + description: '[Output only] A predetermined duration for the window, automatically + chosen to be the smallest possible in the given scenario.' + startTime: + description: Start time of the window. This must be in UTC format that resolves + to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both + 13:00-5 and 08:00 are valid. + type: string + type: object + NodeGroupNode: + properties: + accelerators: + description: Accelerators for this node. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + cpuOvercommitType: + description: CPU overcommit. + enum: + - CPU_OVERCOMMIT_TYPE_UNSPECIFIED + - ENABLED + - NONE + type: string + disks: + description: Local disk configurations. + items: + $ref: '#/components/schemas/LocalDisk' + type: array + instances: + description: Instances scheduled on this node. + items: + type: string + type: array + name: + description: The name of the node. + type: string + nodeType: + description: The type of this node. + type: string + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + serverBinding: + $ref: '#/components/schemas/ServerBinding' + description: Binding properties for the physical server. + serverId: + description: Server ID associated with this node. + type: string + status: + enum: + - CREATING + - DELETING + - INVALID + - READY + - REPAIRING + type: string + type: object + NodeGroupsAddNodesRequest: + properties: + additionalNodeCount: + description: Count of additional nodes to be added to the node group. + format: int32 + type: integer + type: object + NodeGroupsDeleteNodesRequest: + properties: + nodes: + description: Names of the nodes to delete. + items: + type: string + type: array + type: object + NodeGroupsListNodes: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Node resources. + items: + $ref: '#/components/schemas/NodeGroupNode' + type: array + kind: + default: compute#nodeGroupsListNodes + description: '[Output Only] The resource type, which is always compute.nodeGroupsListNodes + for the list of nodes in the specified node group.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeGroupsScopedList: + properties: + nodeGroups: + description: '[Output Only] A list of node groups contained in this scope.' + items: + $ref: '#/components/schemas/NodeGroup' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + nodeGroup 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeGroupsSetNodeTemplateRequest: + properties: + nodeTemplate: + description: Full or partial URL of the node template resource to be updated + for this node group. + type: string + type: object + NodeTemplate: + description: Represent a sole-tenant Node Template resource. You can use a template + to define properties for nodes in a node group. For more information, read + Creating node groups and instances. + properties: + accelerators: + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + cpuOvercommitType: + description: CPU overcommit. + enum: + - CPU_OVERCOMMIT_TYPE_UNSPECIFIED + - ENABLED + - NONE + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + disks: + items: + $ref: '#/components/schemas/LocalDisk' + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#nodeTemplate + description: '[Output Only] The type of the resource. Always compute#nodeTemplate + for node templates.' + type: string + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + nodeAffinityLabels: + additionalProperties: + type: string + description: Labels to use for node affinity, which will be used in instance + scheduling. + type: object + nodeType: + description: The node type to use for nodes group that are created from + this template. + type: string + nodeTypeFlexibility: + $ref: '#/components/schemas/NodeTemplateNodeTypeFlexibility' + description: The flexible properties of the desired node type. Node groups + that use this node template will create nodes of a type that matches these + properties. This field is mutually exclusive with the node_type property; + you can only define one or the other, but not both. + region: + description: '[Output Only] The name of the region where the node template + resides, such as us-central1.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + serverBinding: + $ref: '#/components/schemas/ServerBinding' + description: 'Sets the binding properties for the physical server. Valid + values include: - *[Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs + on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts + VMs on the same physical server whenever possible See Sole-tenant node + options for more information.' + status: + description: '[Output Only] The status of the node template. One of the + following values: CREATING, READY, and DELETING.' + enum: + - CREATING + - DELETING + - INVALID + - READY + type: string + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the + status.' + type: string + type: object + NodeTemplateAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/NodeTemplatesScopedList' + description: '[Output Only] Name of the scope containing this set of node + templates.' + description: A list of NodeTemplatesScopedList resources. + type: object + kind: + default: compute#nodeTemplateAggregatedList + description: '[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList + for aggregated lists of node templates.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeTemplateList: + description: Contains a list of node templates. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NodeTemplate resources. + items: + $ref: '#/components/schemas/NodeTemplate' + type: array + kind: + default: compute#nodeTemplateList + description: '[Output Only] Type of resource.Always compute#nodeTemplateList + for lists of node templates.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeTemplateNodeTypeFlexibility: + properties: + cpus: + type: string + localSsd: + type: string + memory: + type: string + type: object + NodeTemplatesScopedList: + properties: + nodeTemplates: + description: '[Output Only] A list of node templates contained in this scope.' + items: + $ref: '#/components/schemas/NodeTemplate' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + node templates 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeType: + description: Represent a sole-tenant Node Type resource. Each node within a + node group must have a node type. A node type specifies the total amount of + cores and memory for that node. Currently, the only available node type is + n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available + in multiple zones. For more information read Node types. + properties: + cpuPlatform: + description: '[Output Only] The CPU platform used by this node type.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + node type.' + description: + description: '[Output Only] An optional textual description of the resource.' + type: string + guestCpus: + description: '[Output Only] The number of virtual CPUs that are available + to the node type.' + format: int32 + type: integer + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#nodeType + description: '[Output Only] The type of the resource. Always compute#nodeType + for node types.' + type: string + localSsdGb: + description: '[Output Only] Local SSD available to the node type, defined + in GB.' + format: int32 + type: integer + memoryMb: + description: '[Output Only] The amount of physical memory available to the + node type, defined in MB.' + format: int32 + type: integer + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + zone: + description: '[Output Only] The name of the zone where the node type resides, + such as us-central1-a.' + type: string + type: object + NodeTypeAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/NodeTypesScopedList' + description: '[Output Only] Name of the scope containing this set of node + types.' + description: A list of NodeTypesScopedList resources. + type: object + kind: + default: compute#nodeTypeAggregatedList + description: '[Output Only] Type of resource.Always compute#nodeTypeAggregatedList + for aggregated lists of node types.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeTypeList: + description: Contains a list of node types. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NodeType resources. + items: + $ref: '#/components/schemas/NodeType' + type: array + kind: + default: compute#nodeTypeList + description: '[Output Only] Type of resource.Always compute#nodeTypeList + for lists of node types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NodeTypesScopedList: + properties: + nodeTypes: + description: '[Output Only] A list of node types contained in this scope.' + items: + $ref: '#/components/schemas/NodeType' + type: array + warning: + description: '[Output Only] An informational warning that appears when the + node types 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + NotificationEndpoint: + description: Represents a notification endpoint. A notification endpoint resource + defines an endpoint to receive notifications when there are status changes + detected by the associated health check service. For more information, see + Health checks overview. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + grpcSettings: + $ref: '#/components/schemas/NotificationEndpointGrpcSettings' + description: Settings of the gRPC notification endpoint including the endpoint + URL and the retry duration. + id: + description: '[Output Only] A unique identifier for this resource type. + The server generates this identifier.' + format: uint64 + type: string + kind: + default: compute#notificationEndpoint + description: '[Output Only] Type of the resource. Always compute#notificationEndpoint + for notification endpoints.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + region: + description: '[Output Only] URL of the region where the notification endpoint + resides. This field applies only to the regional resource. You must specify + this field as part of the HTTP request URL. It is not settable as a field + in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + NotificationEndpointGrpcSettings: + description: Represents a gRPC setting that describes one gRPC notification + endpoint and the retry duration attempting to send notification to this endpoint. + properties: + authority: + description: Optional. If specified, this field is used to set the authority + header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 + type: string + endpoint: + description: Endpoint to which gRPC notifications are sent. This must be + a valid gRPCLB DNS name. + type: string + payloadName: + description: Optional. If specified, this field is used to populate the + "name" field in gRPC requests. + type: string + resendInterval: + $ref: '#/components/schemas/Duration' + description: Optional. This field is used to configure how often to send + a full update of all non-healthy backends. If unspecified, full updates + are not sent. If specified, must be in the range between 600 seconds to + 3600 seconds. Nanos are disallowed. + retryDurationSec: + description: How much time (in seconds) is spent attempting notification + retries until a successful response is received. Default is 30s. Limit + is 20m (1200s). Must be a positive number. + format: uint32 + type: integer + type: object + NotificationEndpointList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of NotificationEndpoint resources. + items: + $ref: '#/components/schemas/NotificationEndpoint' + type: array + kind: + default: compute#notificationEndpointList + description: '[Output Only] Type of the resource. Always compute#notificationEndpoint + for notification endpoints.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Operation: + description: 'Represents an Operation resource. Google Compute Engine has three + Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) + * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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.' + properties: + clientOperationId: + description: '[Output Only] The value of `requestId` if you provided it + in the request. Not present otherwise.' + type: string + creationTimestamp: + description: '[Deprecated] This field is deprecated.' + type: string + description: + description: '[Output Only] A textual description of the operation, which + is set when the operation is created.' + type: string + endTime: + description: '[Output Only] The time that this operation was completed. + This value is in RFC3339 text format.' + type: string + error: + description: '[Output Only] If errors are generated during processing of + the operation, this field will be populated.' + 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 + 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 + httpErrorMessage: + description: '[Output Only] If the operation fails, this field contains + the HTTP error message that was returned, such as `NOT FOUND`.' + type: string + httpErrorStatusCode: + description: '[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.' + format: int32 + type: integer + id: + description: '[Output Only] The unique identifier for the operation. This + identifier is defined by the server.' + format: uint64 + type: string + insertTime: + description: '[Output Only] The time that this operation was requested. + This value is in RFC3339 text format.' + type: string + kind: + default: compute#operation + description: '[Output Only] Type of the resource. Always `compute#operation` + for Operation resources.' + type: string + name: + description: '[Output Only] Name of the operation.' + type: string + operationGroupId: + description: '[Output Only] An ID that represents a group of operations, + such as when a group of operations results from a `bulkInsert` API request.' + type: string + operationType: + description: '[Output Only] The type of operation, such as `insert`, `update`, + or `delete`, and so on.' + type: string + progress: + description: '[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.' + format: int32 + type: integer + region: + description: '[Output Only] The URL of the region where the operation resides. + Only applicable when performing regional operations.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + startTime: + description: '[Output Only] The time that this operation was started by + the server. This value is in RFC3339 text format.' + type: string + status: + description: '[Output Only] The status of the operation, which can be one + of the following: `PENDING`, `RUNNING`, or `DONE`.' + enum: + - DONE + - PENDING + - RUNNING + type: string + statusMessage: + description: '[Output Only] An optional textual description of the current + status of the operation.' + type: string + targetId: + description: '[Output Only] The unique target ID, which identifies a specific + incarnation of the target resource.' + format: uint64 + type: string + targetLink: + description: '[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.' + type: string + user: + description: '[Output Only] User who requested the operation, for example: + `user@example.com`.' + type: string + warnings: + description: '[Output Only] If warning messages are generated during processing + of the operation, this field will be populated.' + items: + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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: array + zone: + description: '[Output Only] The URL of the zone where the operation resides. + Only applicable when performing per-zone operations.' + type: string + type: object + OperationAggregatedList: + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/OperationsScopedList' + description: '[Output Only] Name of the scope containing this set of operations.' + description: '[Output Only] A map of scoped operation lists.' + type: object + kind: + default: compute#operationAggregatedList + description: '[Output Only] Type of resource. Always `compute#operationAggregatedList` + for aggregated lists of operations.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + OperationList: + description: Contains a list of Operation resources. + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + description: '[Output Only] A list of Operation resources.' + items: + $ref: '#/components/schemas/Operation' + type: array + kind: + default: compute#operationList + description: '[Output Only] Type of resource. Always `compute#operations` + for Operations 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + OperationsScopedList: + properties: + operations: + description: '[Output Only] A list of operations contained in this scope.' + items: + $ref: '#/components/schemas/Operation' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of operations 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + OutlierDetection: + description: Settings controlling the eviction of unhealthy hosts from the load + balancing pool for the backend service. + properties: + baseEjectionTime: + $ref: '#/components/schemas/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. + 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. + 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. + 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. + 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. + 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. + format: int32 + type: integer + interval: + $ref: '#/components/schemas/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. + maxEjectionPercent: + description: Maximum percentage of hosts in the load balancing pool for + the backend service that can be ejected. 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. + 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. + 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.' + format: int32 + type: integer + type: object + PacketIntervals: + description: 'Next free: 7' + properties: + avgMs: + description: Average observed inter-packet interval in milliseconds. + format: int64 + type: string + duration: + description: From how long ago in the past these intervals were observed. + enum: + - DURATION_UNSPECIFIED + - HOUR + - MAX + - MINUTE + type: string + maxMs: + description: Maximum observed inter-packet interval in milliseconds. + format: int64 + type: string + minMs: + description: Minimum observed inter-packet interval in milliseconds. + format: int64 + type: string + numIntervals: + description: Number of inter-packet intervals from which these statistics + were derived. + format: int64 + type: string + type: + description: The type of packets for which inter-packet intervals were computed. + enum: + - LOOPBACK + - RECEIVE + - TRANSMIT + - TYPE_UNSPECIFIED + type: string + type: object + PacketMirroring: + description: Represents a Packet Mirroring resource. Packet Mirroring clones + the traffic of specified instances in your Virtual Private Cloud (VPC) network + and forwards it to a collector destination, such as an instance group of an + internal TCP/UDP load balancer, for analysis or examination. For more information + about setting up Packet Mirroring, see Using Packet Mirroring. + properties: + collectorIlb: + $ref: '#/components/schemas/PacketMirroringForwardingRuleInfo' + description: The Forwarding Rule resource of type loadBalancingScheme=INTERNAL + that will be used as collector for mirrored traffic. The specified forwarding + rule must have isMirroringCollector set to true. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + enable: + description: Indicates whether or not this packet mirroring takes effect. + If set to FALSE, this packet mirroring policy will not be enforced on + the network. The default is TRUE. + enum: + - 'FALSE' + - 'TRUE' + type: string + filter: + $ref: '#/components/schemas/PacketMirroringFilter' + description: Filter for mirrored traffic. If unspecified, all traffic is + mirrored. + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#packetMirroring + description: '[Output Only] Type of the resource. Always compute#packetMirroring + for packet mirrorings.' + type: string + mirroredResources: + $ref: '#/components/schemas/PacketMirroringMirroredResourceInfo' + description: PacketMirroring mirroredResourceInfos. MirroredResourceInfo + specifies a set of mirrored VM instances, subnetworks and/or tags for + which traffic from/to all VM instances will be mirrored. + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + $ref: '#/components/schemas/PacketMirroringNetworkInfo' + description: Specifies the mirrored VPC network. Only packets in this network + will be mirrored. All mirrored VMs should have a NIC in the given network. + All mirrored subnetworks should belong to the given network. + priority: + description: The priority of applying this configuration. Priority is used + to break ties in cases where there is more than one matching rule. In + the case of two rules that apply for a given Instance, the one with the + lowest-numbered priority value wins. Default value is 1000. Valid range + is 0 through 65535. + format: uint32 + type: integer + region: + description: '[Output Only] URI of the region where the packetMirroring + resides.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + PacketMirroringAggregatedList: + description: Contains a list of packetMirrorings. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/PacketMirroringsScopedList' + description: Name of the scope containing this set of packetMirrorings. + description: A list of PacketMirroring resources. + type: object + kind: + default: compute#packetMirroringAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PacketMirroringFilter: + properties: + IPProtocols: + description: Protocols that apply as filter on mirrored traffic. If no protocols + are specified, all traffic that matches the specified CIDR ranges is mirrored. + If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored. + items: + type: string + type: array + cidrRanges: + description: IP CIDR ranges that apply as filter on the source (ingress) + or destination (egress) IP in the IP header. Only IPv4 is supported. If + no ranges are specified, all traffic that matches the specified IPProtocols + is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic + is mirrored. + items: + type: string + type: array + direction: + description: Direction of traffic to mirror, either INGRESS, EGRESS, or + BOTH. The default is BOTH. + enum: + - BOTH + - EGRESS + - INGRESS + type: string + type: object + PacketMirroringForwardingRuleInfo: + properties: + canonicalUrl: + description: '[Output Only] Unique identifier for the forwarding rule; defined + by the server.' + type: string + url: + description: Resource URL to the forwarding rule representing the ILB configured + as destination of the mirrored traffic. + type: string + type: object + PacketMirroringList: + description: Contains a list of PacketMirroring resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of PacketMirroring resources. + items: + $ref: '#/components/schemas/PacketMirroring' + type: array + kind: + default: compute#packetMirroringList + description: '[Output Only] Type of resource. Always compute#packetMirroring + for packetMirrorings.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PacketMirroringMirroredResourceInfo: + properties: + instances: + description: A set of virtual machine instances that are being mirrored. + They must live in zones contained in the same region as this packetMirroring. + Note that this config will apply only to those network interfaces of the + Instances that belong to the network specified in this packetMirroring. + You may specify a maximum of 50 Instances. + items: + $ref: '#/components/schemas/PacketMirroringMirroredResourceInfoInstanceInfo' + type: array + subnetworks: + description: A set of subnetworks for which traffic from/to all VM instances + will be mirrored. They must live in the same region as this packetMirroring. + You may specify a maximum of 5 subnetworks. + items: + $ref: '#/components/schemas/PacketMirroringMirroredResourceInfoSubnetInfo' + type: array + tags: + description: A set of mirrored tags. Traffic from/to all VM instances that + have one or more of these tags will be mirrored. + items: + type: string + type: array + type: object + PacketMirroringMirroredResourceInfoInstanceInfo: + properties: + canonicalUrl: + description: '[Output Only] Unique identifier for the instance; defined + by the server.' + type: string + url: + description: Resource URL to the virtual machine instance which is being + mirrored. + type: string + type: object + PacketMirroringMirroredResourceInfoSubnetInfo: + properties: + canonicalUrl: + description: '[Output Only] Unique identifier for the subnetwork; defined + by the server.' + type: string + url: + description: Resource URL to the subnetwork for which traffic from/to all + VM instances will be mirrored. + type: string + type: object + PacketMirroringNetworkInfo: + properties: + canonicalUrl: + description: '[Output Only] Unique identifier for the network; defined by + the server.' + type: string + url: + description: URL of the network resource. + type: string + type: object + PacketMirroringsScopedList: + properties: + packetMirrorings: + description: A list of packetMirrorings contained in this scope. + items: + $ref: '#/components/schemas/PacketMirroring' + type: array + warning: + description: Informational warning which replaces the list of packetMirrorings + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PathMatcher: + description: A matcher for the path portion of the URL. The BackendService from + the longest-matched rule will serve the URL. If no rule was matched, the default + service will be used. + properties: + defaultRouteAction: + $ref: '#/components/schemas/HttpRouteAction' + description: defaultRouteAction takes effect when none of the pathRules + or routeRules match. The load balancer performs advanced routing actions + like URL rewrites, header transformations, etc. prior to forwarding the + request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, + defaultService must not be set. Conversely if defaultService is set, defaultRouteAction + cannot contain any weightedBackendServices. Only one of defaultRouteAction + or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers + support only the urlRewrite action within a pathMatcher's defaultRouteAction. + defaultService: + description: 'The full or partial URL to the BackendService resource. This + will be used if none of the pathRules or routeRules defined by this PathMatcher + are matched. For example, the following are all valid URLs to a BackendService + resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService + - compute/v1/projects/project/global/backendServices/backendService - + global/backendServices/backendService If defaultRouteAction is additionally + specified, advanced routing actions like URL Rewrites, etc. take effect + prior to sending the request to the backend. However, if defaultService + is specified, defaultRouteAction cannot contain any weightedBackendServices. + Conversely, if defaultRouteAction specifies any weightedBackendServices, + defaultService must not be specified. Only one of defaultService, defaultUrlRedirect + or defaultRouteAction.weightedBackendService must be set. Authorization + requires one or more of the following Google IAM permissions on the specified + resource default_service: - compute.backendBuckets.use - compute.backendServices.use ' + type: string + defaultUrlRedirect: + $ref: '#/components/schemas/HttpRedirectAction' + description: When none of the specified pathRules or routeRules match, the + request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect + is specified, defaultService or defaultRouteAction must not be set. Not + supported when the URL map is bound to target gRPC proxy. + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + headerAction: + $ref: '#/components/schemas/HttpHeaderAction' + description: Specifies changes to request and response headers that need + to take effect for the selected backendService. HeaderAction specified + here are applied after the matching HttpRouteRule HeaderAction and before + the HeaderAction in the UrlMap Note that headerAction is not supported + for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. + Not supported when the URL map is bound to target gRPC proxy that has + validateForProxyless field set to true. + name: + description: The name to which this PathMatcher is referred by the HostRule. + type: string + pathRules: + description: 'The list of path rules. Use this list instead of routeRules + when routing based on simple path matching is all that''s required. The + order by which path rules are specified does not matter. Matches are always + done on the longest-path-first basis. For example: a pathRule with a path + /a/b/c/* will match before /a/b/* irrespective of the order in which those + paths appear in this list. Within a given pathMatcher, only one of pathRules + or routeRules must be set.' + items: + $ref: '#/components/schemas/PathRule' + type: array + routeRules: + description: The list of HTTP route rules. Use this list instead of pathRules + when advanced route matching and routing actions are desired. routeRules + are evaluated in order of priority, from the lowest to highest number. + Within a given pathMatcher, you can set only one of pathRules or routeRules. + items: + $ref: '#/components/schemas/HttpRouteRule' + type: array + type: object + PathRule: + description: A path-matching rule for a URL. If matched, will use the specified + BackendService to handle the traffic arriving at this URL. + properties: + paths: + description: 'The list of path patterns to match. Each must start with / + and the only place a * is allowed is at the end following a /. The string + fed to the path matcher does not include any text after the first ? or + #, and those chars are not allowed here.' + items: + type: string + type: array + routeAction: + $ref: '#/components/schemas/HttpRouteAction' + description: In response to a matching path, the load balancer performs + advanced routing actions like URL rewrites, header transformations, etc. + prior to forwarding the request to the selected backend. If routeAction + specifies any weightedBackendServices, service must not be set. Conversely + if service is set, routeAction cannot contain any weightedBackendServices. + Only one of routeAction or urlRedirect must be set. UrlMaps for external + HTTP(S) load balancers support only the urlRewrite action within a pathRule's + routeAction. + service: + description: The full or partial URL of the backend service resource to + which traffic is directed if this rule is matched. If routeAction is additionally + specified, advanced routing actions like URL Rewrites, etc. take effect + prior to sending the request to the backend. However, if service is specified, + routeAction cannot contain any weightedBackendService s. Conversely, if + routeAction specifies any weightedBackendServices, service must not be + specified. Only one of urlRedirect, service or routeAction.weightedBackendService + must be set. + type: string + urlRedirect: + $ref: '#/components/schemas/HttpRedirectAction' + description: When a path pattern is matched, the request is redirected to + a URL specified by urlRedirect. If urlRedirect is specified, service or + routeAction must not be set. Not supported when the URL map is bound to + target gRPC proxy. + type: object + PerInstanceConfig: + properties: + fingerprint: + description: Fingerprint of this per-instance config. This field can be + used in optimistic locking. It is ignored when inserting a per-instance + config. An up-to-date fingerprint must be provided in order to update + an existing per-instance config or the field needs to be unset. + format: byte + type: string + name: + description: The name of a per-instance config and its corresponding instance. + Serves as a merge key during UpdatePerInstanceConfigs operations, that + is, if a per-instance config with the same name exists then it will be + updated, otherwise a new one will be created for the VM instance with + the same name. An attempt to create a per-instance config for a VM instance + that either doesn't exist or is not part of the group will result in an + error. + type: string + preservedState: + $ref: '#/components/schemas/PreservedState' + description: The intended preserved state for the given instance. Does not + contain preserved state generated from a stateful policy. + status: + description: The status of applying this per-instance config on the corresponding + managed instance. + enum: + - APPLYING + - DELETING + - EFFECTIVE + - NONE + - UNAPPLIED + - UNAPPLIED_DELETION + 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` to a single `role`. Members + can be user accounts, service accounts, Google groups, and domains (such as + G Suite). A `role` is a named list of permissions; each `role` can be an IAM + predefined role or a user-created custom role. For some types of Google Cloud + resources, a `binding` can also specify a `condition`, which is a logical + expression that allows access to a resource only if the expression evaluates + to `true`. A condition can add constraints based on attributes of the request, + the resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": + "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" + ], "condition": { "title": "expirable access", "description": "Does not grant + access after Sep 2020", "expression": "request.time < timestamp(''2020-10-01T00:00:00.000Z'')", + } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: + - members: - user:mike@example.com - group:admins@example.com - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin + - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access after + Sep 2020 expression: request.time < timestamp(''2020-10-01T00:00:00.000Z'') + etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see + the [IAM documentation](https://cloud.google.com/iam/docs/).' + properties: + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + items: + $ref: '#/components/schemas/AuditConfig' + type: array + bindings: + description: Associates a list of `members` to a `role`. Optionally, may + specify a `condition` that determines how and when the `bindings` are + applied. Each of the `bindings` must contain at least one member. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: '`etag` is used for optimistic concurrency control as a way + to help prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` in + the read-modify-write cycle to perform policy updates in order to avoid + race conditions: An `etag` is returned in the response to `getIamPolicy`, + and systems are expected to put that etag in the request to `setIamPolicy` + to ensure that their change will be applied to the same version of the + policy. **Important:** If you use IAM Conditions, you must include the + `etag` field whenever you call `setIamPolicy`. If you omit this field, + then IAM allows you to overwrite a version `3` policy with a version `1` + policy, and all of the conditions in the version `3` policy are lost.' + format: byte + type: string + iamOwned: + description: This is deprecated and has no effect. Do not use. + type: boolean + rules: + description: This is deprecated and has no effect. Do not use. + items: + $ref: '#/components/schemas/Rule' + type: array + version: + description: 'Specifies the format of the policy. Valid values are `0`, + `1`, and `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify version + `3`. This requirement applies to the following operations: * Getting a + policy that includes a conditional role binding * Adding a conditional + role binding to a policy * Changing a conditional role binding in a policy + * Removing any role binding, with or without a condition, from a policy + that includes conditions **Important:** If you use IAM Conditions, you + must include the `etag` field whenever you call `setIamPolicy`. If you + omit this field, then IAM allows you to overwrite a version `3` policy + with a version `1` policy, and all of the conditions in the version `3` + policy are lost. If a policy does not include any conditions, operations + on that policy may specify any valid version or leave the field unset. + To learn which resources support conditions in their IAM policies, see + the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).' + format: int32 + type: integer + type: object + PreconfiguredWafSet: + properties: + expressionSets: + description: List of entities that are currently supported for WAF rules. + items: + $ref: '#/components/schemas/WafExpressionSet' + type: array + type: object + PreservedState: + description: Preserved state for a given instance. + properties: + disks: + additionalProperties: + $ref: '#/components/schemas/PreservedStatePreservedDisk' + description: Preserved disks defined for this instance. This map is keyed + with the device names of the disks. + type: object + metadata: + additionalProperties: + type: string + description: Preserved metadata defined for this instance. + type: object + type: object + PreservedStatePreservedDisk: + properties: + autoDelete: + description: 'These stateful disks will never be deleted during autohealing, + update, instance recreate operations. This flag is used to configure if + the disk should be deleted after it is no longer used by the group, e.g. + when the given instance or the whole MIG is deleted. Note: disks attached + in READ_ONLY mode cannot be auto-deleted.' + enum: + - NEVER + - ON_PERMANENT_INSTANCE_DELETION + type: string + mode: + description: The mode in which to attach this disk, either READ_WRITE or + READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE + mode. + enum: + - READ_ONLY + - READ_WRITE + type: string + source: + description: The URL of the disk resource that is stateful and should be + attached to the VM instance. + type: string + type: object + Project: + description: Represents a Project resource. A project is used to organize resources + in a Google Cloud Platform environment. For more information, read about the + Resource Hierarchy. + properties: + commonInstanceMetadata: + $ref: '#/components/schemas/Metadata' + description: Metadata key/value pairs available to all instances contained + in this project. See Custom metadata for more information. + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + defaultNetworkTier: + description: 'This signifies the default network tier used for configuring + resources of the project and can only take the following values: PREMIUM, + STANDARD. Initially the default network tier is PREMIUM.' + enum: + - PREMIUM + - STANDARD + type: string + defaultServiceAccount: + description: '[Output Only] Default service account used by VMs running + in this project.' + type: string + description: + description: An optional textual description of the resource. + type: string + enabledFeatures: + description: Restricted features enabled for use on this project. + items: + type: string + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server. This is *not* the project ID, and + is just a unique ID used by Compute Engine to identify resources.' + format: uint64 + type: string + kind: + default: compute#project + description: '[Output Only] Type of the resource. Always compute#project + for projects.' + type: string + name: + description: 'The project ID. For example: my-example-project. Use the project + ID to make requests to Compute Engine.' + type: string + quotas: + description: '[Output Only] Quotas assigned to this project.' + items: + $ref: '#/components/schemas/Quota' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + usageExportLocation: + $ref: '#/components/schemas/UsageExportLocation' + description: The naming prefix for daily usage reports and the Google Cloud + Storage bucket where they are stored. + xpnProjectStatus: + description: '[Output Only] The role this project has in a shared VPC configuration. + Currently, only projects with the host role, which is specified by the + value HOST, are differentiated.' + enum: + - HOST + - UNSPECIFIED_XPN_PROJECT_STATUS + type: string + type: object + ProjectsDisableXpnResourceRequest: + properties: + xpnResource: + $ref: '#/components/schemas/XpnResourceId' + description: Service resource (a.k.a service project) ID. + type: object + ProjectsEnableXpnResourceRequest: + properties: + xpnResource: + $ref: '#/components/schemas/XpnResourceId' + description: Service resource (a.k.a service project) ID. + type: object + ProjectsGetXpnResources: + properties: + kind: + default: compute#projectsGetXpnResources + description: '[Output Only] Type of resource. Always compute#projectsGetXpnResources + for lists of service resources (a.k.a service projects)' + 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 + resources: + description: Service resources (a.k.a service projects) attached to this + project as their shared VPC host. + items: + $ref: '#/components/schemas/XpnResourceId' + type: array + type: object + ProjectsListXpnHostsRequest: + properties: + organization: + description: Optional organization ID managed by Cloud Resource Manager, + for which to list shared VPC host projects. If not specified, the organization + will be inferred from the project. + type: string + type: object + ProjectsSetDefaultNetworkTierRequest: + properties: + networkTier: + description: Default network tier to be set. + enum: + - PREMIUM + - STANDARD + type: string + type: object + PublicAdvertisedPrefix: + description: A public advertised prefix represents an aggregated IP prefix or + netblock which customers bring to cloud. The IP prefix is a single unit of + route advertisement and is announced globally to the internet. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + dnsVerificationIp: + description: The IPv4 address to be used for reverse DNS verification. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date + fingerprint must be provided in order to update the PublicAdvertisedPrefix, + otherwise the request will fail with error 412 conditionNotMet. To see + the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource type. + The server generates this identifier.' + format: uint64 + type: string + ipCidrRange: + description: The IPv4 address range, in CIDR format, represented by this + public advertised prefix. + type: string + kind: + default: compute#publicAdvertisedPrefix + description: '[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix + for public advertised prefixes.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + publicDelegatedPrefixs: + description: '[Output Only] The list of public delegated prefixes that exist + for this public advertised prefix.' + items: + $ref: '#/components/schemas/PublicAdvertisedPrefixPublicDelegatedPrefix' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sharedSecret: + description: '[Output Only] The shared secret to be used for reverse DNS + verification.' + type: string + status: + description: The status of the public advertised prefix. + enum: + - INITIAL + - PREFIX_CONFIGURATION_COMPLETE + - PREFIX_CONFIGURATION_IN_PROGRESS + - PREFIX_REMOVAL_IN_PROGRESS + - PTR_CONFIGURED + - REVERSE_DNS_LOOKUP_FAILED + - VALIDATED + type: string + type: object + PublicAdvertisedPrefixList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of PublicAdvertisedPrefix resources. + items: + $ref: '#/components/schemas/PublicAdvertisedPrefix' + type: array + kind: + default: compute#publicAdvertisedPrefixList + description: '[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix + for public advertised prefixes.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PublicAdvertisedPrefixPublicDelegatedPrefix: + description: Represents a CIDR range which can be used to assign addresses. + properties: + ipRange: + description: The IP address range of the public delegated prefix + type: string + name: + description: The name of the public delegated prefix + type: string + project: + description: The project number of the public delegated prefix + type: string + region: + description: The region of the public delegated prefix if it is regional. + If absent, the prefix is global. + type: string + status: + description: 'The status of the public delegated prefix. Possible values + are: INITIALIZING: The public delegated prefix is being initialized and + addresses cannot be created yet. ANNOUNCED: The public delegated prefix + is active.' + type: string + type: object + PublicDelegatedPrefix: + description: A PublicDelegatedPrefix resource represents an IP block within + a PublicAdvertisedPrefix that is configured within a single cloud scope (global + or region). IPs in the block can be allocated to resources within that scope. + Public delegated prefixes may be further broken up into smaller IP blocks + in the same scope as the parent block. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint + must be provided in order to update the PublicDelegatedPrefix, otherwise + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource type. + The server generates this identifier.' + format: uint64 + type: string + ipCidrRange: + description: The IPv4 address range, in CIDR format, represented by this + public delegated prefix. + type: string + isLiveMigration: + description: If true, the prefix will be live migrated. + type: boolean + kind: + default: compute#publicDelegatedPrefix + description: '[Output Only] Type of the resource. Always compute#publicDelegatedPrefix + for public delegated prefixes.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + parentPrefix: + description: The URL of parent prefix. Either PublicAdvertisedPrefix or + PublicDelegatedPrefix. + type: string + publicDelegatedSubPrefixs: + description: The list of sub public delegated prefixes that exist for this + public delegated prefix. + items: + $ref: '#/components/schemas/PublicDelegatedPrefixPublicDelegatedSubPrefix' + type: array + region: + description: '[Output Only] URL of the region where the public delegated + prefix resides. This field applies only to the region resource. You must + specify this field as part of the HTTP request URL. It is not settable + as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of the public delegated prefix.' + enum: + - ANNOUNCED + - DELETING + - INITIALIZING + - READY_TO_ANNOUNCE + type: string + type: object + PublicDelegatedPrefixAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/PublicDelegatedPrefixesScopedList' + description: '[Output Only] Name of the scope containing this set of PublicDelegatedPrefixes.' + description: A list of PublicDelegatedPrefixesScopedList resources. + type: object + kind: + default: compute#publicDelegatedPrefixAggregatedList + description: '[Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList + for aggregated lists of public delegated prefixes.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PublicDelegatedPrefixList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of PublicDelegatedPrefix resources. + items: + $ref: '#/components/schemas/PublicDelegatedPrefix' + type: array + kind: + default: compute#publicDelegatedPrefixList + description: '[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList + for public delegated prefixes.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + PublicDelegatedPrefixPublicDelegatedSubPrefix: + description: Represents a sub PublicDelegatedPrefix. + properties: + delegateeProject: + description: Name of the project scoping this PublicDelegatedSubPrefix. + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + ipCidrRange: + description: The IPv4 address range, in CIDR format, represented by this + sub public delegated prefix. + type: string + isAddress: + description: Whether the sub prefix is delegated to create Address resources + in the delegatee project. + type: boolean + name: + description: The name of the sub public delegated prefix. + type: string + region: + description: '[Output Only] The region of the sub public delegated prefix + if it is regional. If absent, the sub prefix is global.' + type: string + status: + description: '[Output Only] The status of the sub public delegated prefix.' + enum: + - ACTIVE + - INACTIVE + type: string + type: object + PublicDelegatedPrefixesScopedList: + properties: + publicDelegatedPrefixes: + description: '[Output Only] A list of PublicDelegatedPrefixes contained + in this scope.' + items: + $ref: '#/components/schemas/PublicDelegatedPrefix' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of public delegated prefixes 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Quota: + description: A quotas entry. + properties: + limit: + description: '[Output Only] Quota limit for this metric.' + format: double + type: number + metric: + description: '[Output Only] Name of the quota metric.' + enum: + - A2_CPUS + - AFFINITY_GROUPS + - AUTOSCALERS + - BACKEND_BUCKETS + - BACKEND_SERVICES + - C2D_CPUS + - C2_CPUS + - C3_CPUS + - COMMITMENTS + - COMMITTED_A2_CPUS + - COMMITTED_C2D_CPUS + - COMMITTED_C2_CPUS + - COMMITTED_C3_CPUS + - COMMITTED_CPUS + - COMMITTED_E2_CPUS + - COMMITTED_LICENSES + - COMMITTED_LOCAL_SSD_TOTAL_GB + - COMMITTED_MEMORY_OPTIMIZED_CPUS + - COMMITTED_N2A_CPUS + - COMMITTED_N2D_CPUS + - COMMITTED_N2_CPUS + - COMMITTED_NVIDIA_A100_GPUS + - COMMITTED_NVIDIA_K80_GPUS + - COMMITTED_NVIDIA_P100_GPUS + - COMMITTED_NVIDIA_P4_GPUS + - COMMITTED_NVIDIA_T4_GPUS + - COMMITTED_NVIDIA_V100_GPUS + - COMMITTED_T2D_CPUS + - CPUS + - CPUS_ALL_REGIONS + - DISKS_TOTAL_GB + - E2_CPUS + - EXTERNAL_NETWORK_LB_FORWARDING_RULES + - EXTERNAL_PROTOCOL_FORWARDING_RULES + - EXTERNAL_VPN_GATEWAYS + - FIREWALLS + - FORWARDING_RULES + - GLOBAL_INTERNAL_ADDRESSES + - GPUS_ALL_REGIONS + - HEALTH_CHECKS + - IMAGES + - INSTANCES + - INSTANCE_GROUPS + - INSTANCE_GROUP_MANAGERS + - INSTANCE_TEMPLATES + - INTERCONNECTS + - INTERCONNECT_ATTACHMENTS_PER_REGION + - INTERCONNECT_ATTACHMENTS_TOTAL_MBPS + - INTERCONNECT_TOTAL_GBPS + - INTERNAL_ADDRESSES + - INTERNAL_TRAFFIC_DIRECTOR_FORWARDING_RULES + - IN_PLACE_SNAPSHOTS + - IN_USE_ADDRESSES + - IN_USE_BACKUP_SCHEDULES + - IN_USE_SNAPSHOT_SCHEDULES + - LOCAL_SSD_TOTAL_GB + - M1_CPUS + - M2_CPUS + - MACHINE_IMAGES + - N2A_CPUS + - N2D_CPUS + - N2_CPUS + - NETWORKS + - NETWORK_ENDPOINT_GROUPS + - NETWORK_FIREWALL_POLICIES + - NODE_GROUPS + - NODE_TEMPLATES + - NVIDIA_A100_GPUS + - NVIDIA_K80_GPUS + - NVIDIA_P100_GPUS + - NVIDIA_P100_VWS_GPUS + - NVIDIA_P4_GPUS + - NVIDIA_P4_VWS_GPUS + - NVIDIA_T4_GPUS + - NVIDIA_T4_VWS_GPUS + - NVIDIA_V100_GPUS + - PACKET_MIRRORINGS + - PD_EXTREME_TOTAL_PROVISIONED_IOPS + - PREEMPTIBLE_CPUS + - PREEMPTIBLE_LOCAL_SSD_GB + - PREEMPTIBLE_NVIDIA_A100_GPUS + - PREEMPTIBLE_NVIDIA_K80_GPUS + - PREEMPTIBLE_NVIDIA_P100_GPUS + - PREEMPTIBLE_NVIDIA_P100_VWS_GPUS + - PREEMPTIBLE_NVIDIA_P4_GPUS + - PREEMPTIBLE_NVIDIA_P4_VWS_GPUS + - PREEMPTIBLE_NVIDIA_T4_GPUS + - PREEMPTIBLE_NVIDIA_T4_VWS_GPUS + - PREEMPTIBLE_NVIDIA_V100_GPUS + - PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK + - PSC_INTERNAL_LB_FORWARDING_RULES + - PUBLIC_ADVERTISED_PREFIXES + - PUBLIC_DELEGATED_PREFIXES + - REGIONAL_AUTOSCALERS + - REGIONAL_INSTANCE_GROUP_MANAGERS + - RESERVATIONS + - RESOURCE_POLICIES + - ROUTERS + - ROUTES + - SECURITY_POLICIES + - SECURITY_POLICIES_PER_REGION + - SECURITY_POLICY_CEVAL_RULES + - SECURITY_POLICY_RULES + - SECURITY_POLICY_RULES_PER_REGION + - SERVICE_ATTACHMENTS + - SNAPSHOTS + - SSD_TOTAL_GB + - SSL_CERTIFICATES + - STATIC_ADDRESSES + - STATIC_BYOIP_ADDRESSES + - SUBNETWORKS + - T2D_CPUS + - TARGET_HTTPS_PROXIES + - TARGET_HTTP_PROXIES + - TARGET_INSTANCES + - TARGET_POOLS + - TARGET_SSL_PROXIES + - TARGET_TCP_PROXIES + - TARGET_VPN_GATEWAYS + - URL_MAPS + - VPN_GATEWAYS + - VPN_TUNNELS + - XPN_SERVICE_PROJECTS + type: string + owner: + description: '[Output Only] Owning resource. This is the resource on which + this quota is applied.' + type: string + usage: + description: '[Output Only] Current usage of this metric.' + format: double + type: number + type: object + Reference: + description: Represents a reference to a resource. + properties: + kind: + default: compute#reference + description: '[Output Only] Type of the resource. Always compute#reference + for references.' + type: string + referenceType: + description: 'A description of the reference type with no implied semantics. + Possible values include: 1. MEMBER_OF ' + type: string + referrer: + description: URL of the resource which refers to the target. + type: string + target: + description: URL of the resource to which this reference points. + type: string + type: object + Region: + description: Represents a Region resource. A region is a geographical area where + a resource is located. For more information, read Regions and Zones. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + region.' + description: + description: '[Output Only] Textual description of the resource.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#region + description: '[Output Only] Type of the resource. Always compute#region + for regions.' + type: string + name: + description: '[Output Only] Name of the resource.' + type: string + quotas: + description: '[Output Only] Quotas assigned to this region.' + items: + $ref: '#/components/schemas/Quota' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] Status of the region, either UP or DOWN.' + enum: + - DOWN + - UP + type: string + supportsPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + zones: + description: '[Output Only] A list of zones available in this region, in + the form of resource URLs.' + items: + type: string + type: array + type: object + RegionAutoscalerList: + description: Contains a list of autoscalers. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Autoscaler resources. + items: + $ref: '#/components/schemas/Autoscaler' + type: array + kind: + default: compute#regionAutoscalerList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionDiskTypeList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of DiskType resources. + items: + $ref: '#/components/schemas/DiskType' + type: array + kind: + default: compute#regionDiskTypeList + description: '[Output Only] Type of resource. Always compute#regionDiskTypeList + for region disk types.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionDisksAddResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be added to this disk. + items: + type: string + type: array + type: object + RegionDisksRemoveResourcePoliciesRequest: + properties: + resourcePolicies: + description: Resource policies to be removed from this disk. + items: + type: string + type: array + type: object + RegionDisksResizeRequest: + properties: + sizeGb: + description: The new size of the regional persistent disk, which is specified + in GB. + format: int64 + type: string + type: object + RegionInstanceGroupList: + description: Contains a list of InstanceGroup resources. + 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: '#/components/schemas/InstanceGroup' + type: array + kind: + default: compute#regionInstanceGroupList + description: The resource type. + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionInstanceGroupManagerDeleteInstanceConfigReq: + description: RegionInstanceGroupManagers.deletePerInstanceConfigs + properties: + names: + description: The list of instance names for which we want to delete per-instance + configs on this managed instance group. + items: + type: string + type: array + type: object + RegionInstanceGroupManagerList: + description: Contains a list of managed instance groups. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceGroupManager resources. + items: + $ref: '#/components/schemas/InstanceGroupManager' + type: array + kind: + default: compute#regionInstanceGroupManagerList + description: '[Output Only] The resource type, which is always compute#instanceGroupManagerList + for a list of managed instance groups that exist in th regional scope.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionInstanceGroupManagerPatchInstanceConfigReq: + description: RegionInstanceGroupManagers.patchPerInstanceConfigs + properties: + perInstanceConfigs: + description: The list of per-instance configs to insert or patch on this + managed instance group. + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + RegionInstanceGroupManagerUpdateInstanceConfigReq: + description: RegionInstanceGroupManagers.updatePerInstanceConfigs + properties: + perInstanceConfigs: + description: The list of per-instance configs to insert or patch on this + managed instance group. + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + RegionInstanceGroupManagersAbandonInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to abandon. This can be a + full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + type: object + RegionInstanceGroupManagersApplyUpdatesRequest: + description: RegionInstanceGroupManagers.applyUpdatesToInstances + properties: + allInstances: + description: "Flag to update all instances instead of specified list of\ + \ \u201Cinstances\u201D. If the flag is set to true then the instances\ + \ may not be specified in the request." + type: boolean + instances: + description: The list of URLs of one or more instances for which you want + to apply updates. Each URL can be a full URL or a partial URL, such as + zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + minimalAction: + description: 'The minimal action that you want to perform on each instance + during the update: - REPLACE: At minimum, delete the instance and create + it again. - RESTART: Stop the instance and start it again. - REFRESH: + Do not stop the instance. - NONE: Do not disrupt the instance at all. + By default, the minimum action is NONE. If your update requires a more + disruptive action than you set with this flag, the necessary action is + performed to execute the update.' + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + mostDisruptiveAllowedAction: + description: 'The most disruptive action that you want to perform on each + instance during the update: - REPLACE: Delete the instance and create + it again. - RESTART: Stop the instance and start it again. - REFRESH: + Do not stop the instance. - NONE: Do not disrupt the instance at all. + By default, the most disruptive allowed action is REPLACE. If your update + requires a more disruptive action than you set with this flag, the update + request will fail.' + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + type: string + type: object + RegionInstanceGroupManagersCreateInstancesRequest: + description: RegionInstanceGroupManagers.createInstances + properties: + instances: + description: '[Required] List of specifications of per-instance configs.' + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + type: object + RegionInstanceGroupManagersDeleteInstancesRequest: + properties: + instances: + description: The URLs of one or more instances to delete. This can be a + full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + skipInstancesOnValidationError: + description: Specifies whether the request should proceed despite the inclusion + of instances that are not members of the group or that are already in + the process of being deleted or abandoned. If this field is set to `false` + and such an instance is specified in the request, the operation fails. + The operation always fails if the request contains a malformed instance + URL or a reference to an instance that exists in a zone or region other + than the group's zone or region. + type: boolean + type: object + RegionInstanceGroupManagersListErrorsResponse: + properties: + items: + description: '[Output Only] The list of errors of the managed instance group.' + items: + $ref: '#/components/schemas/InstanceManagedByIgmError' + type: array + 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 + type: object + RegionInstanceGroupManagersListInstanceConfigsResp: + properties: + items: + description: '[Output Only] The list of PerInstanceConfig.' + items: + $ref: '#/components/schemas/PerInstanceConfig' + type: array + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionInstanceGroupManagersListInstancesResponse: + properties: + managedInstances: + description: A list of managed instances. + items: + $ref: '#/components/schemas/ManagedInstance' + type: array + 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 + type: object + RegionInstanceGroupManagersRecreateRequest: + properties: + instances: + description: The URLs of one or more instances to recreate. This can be + a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + items: + type: string + type: array + type: object + RegionInstanceGroupManagersSetTargetPoolsRequest: + properties: + fingerprint: + description: Fingerprint of the target pools information, which is a hash + of the contents. This field is used for optimistic locking when you update + the target pool entries. This field is optional. + format: byte + type: string + targetPools: + description: The URL of all TargetPool resources to which instances in the + instanceGroup field are added. The target pools automatically apply to + all of the instances in the managed instance group. + items: + type: string + type: array + type: object + RegionInstanceGroupManagersSetTemplateRequest: + properties: + instanceTemplate: + description: URL of the InstanceTemplate resource from which all new instances + will be created. + type: string + type: object + RegionInstanceGroupsListInstances: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of InstanceWithNamedPorts resources. + items: + $ref: '#/components/schemas/InstanceWithNamedPorts' + type: array + kind: + default: compute#regionInstanceGroupsListInstances + description: The resource type. + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionInstanceGroupsListInstancesRequest: + properties: + instanceState: + description: 'Instances in which state should be returned. Valid options + are: ''ALL'', ''RUNNING''. By default, it lists all instances.' + enum: + - ALL + - RUNNING + type: string + portName: + description: Name of port user is interested in. It is optional. If it is + set, only information about this ports will be returned. If it is not + set, all the named ports will be returned. Always lists all instances. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + type: object + RegionInstanceGroupsSetNamedPortsRequest: + properties: + fingerprint: + description: The fingerprint of the named ports information for this instance + group. Use this optional property to prevent conflicts when multiple users + change the named ports settings concurrently. Obtain the fingerprint with + the instanceGroups.get method. Then, include the fingerprint in your request + to ensure that you do not overwrite changes that were applied from another + concurrent request. + format: byte + type: string + namedPorts: + description: The list of named ports to set for this instance group. + items: + $ref: '#/components/schemas/NamedPort' + type: array + type: object + RegionList: + description: Contains a list of region resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Region resources. + items: + $ref: '#/components/schemas/Region' + type: array + kind: + default: compute#regionList + description: '[Output Only] Type of resource. Always compute#regionList + for lists of regions.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RegionSetLabelsRequest: + properties: + labelFingerprint: + description: The fingerprint of the previous set of labels for this resource, + used to detect conflicts. The fingerprint is initially generated by Compute + Engine and changes after every request to modify or update labels. You + must always provide an up-to-date fingerprint hash in order to update + or change labels. Make a get() request to the resource to get the latest + fingerprint. + format: byte + type: string + labels: + additionalProperties: + type: string + description: The labels to set for this resource. + type: object + type: object + RegionSetPolicyRequest: + properties: + bindings: + description: Flatten Policy to create a backwacd compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + format: byte + type: string + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the ''resource''. + The size of the policy is limited to a few 10s of KB. An empty policy + is in general a valid policy but certain services (like Projects) might + reject them.' + type: object + RegionTargetHttpsProxiesSetSslCertificatesRequest: + properties: + sslCertificates: + description: New set of SslCertificate resources to associate with this + TargetHttpsProxy resource. Currently exactly one SslCertificate resource + must be specified. + items: + type: string + type: array + type: object + RegionUrlMapsValidateRequest: + properties: + resource: + $ref: '#/components/schemas/UrlMap' + description: Content of the UrlMap to be validated. + type: object + RequestMirrorPolicy: + description: A policy that specifies how requests intended for the route's backends + are shadowed to a separate mirrored backend service. Loadbalancer does not + wait for responses from the shadow service. Prior to sending traffic to the + shadow service, the host / authority header is suffixed with -shadow. + properties: + backendService: + description: The full or partial URL to the BackendService resource being + mirrored to. + type: string + type: object + Reservation: + description: Represents a reservation resource. A reservation ensures that capacity + is held in a specific zone even if the reserved VMs are not running. For more + information, read Reserving zonal resources. + properties: + commitment: + description: '[Output Only] Full or partial URL to a parent commitment. + This field displays for reservations that are tied to a commitment.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#reservation + description: '[Output Only] Type of the resource. Always compute#reservations + for reservations.' + type: string + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this + resource.' + type: string + shareSettings: + $ref: '#/components/schemas/ShareSettings' + description: Share-settings for shared-reservation + specificReservation: + $ref: '#/components/schemas/AllocationSpecificSKUReservation' + description: Reservation for instances with specific machine shapes. + specificReservationRequired: + description: Indicates whether the reservation can be consumed by VMs with + affinity for "any" reservation. If the field is set, then only VMs that + target the reservation by name can consume from this reservation. + type: boolean + status: + description: '[Output Only] The status of the reservation.' + enum: + - CREATING + - DELETING + - INVALID + - READY + - UPDATING + type: string + zone: + description: Zone in which the reservation resides. A zone must be provided + if the reservation is created within a commitment. + type: string + type: object + ReservationAffinity: + description: Specifies the reservations that this instance can consume from. + properties: + consumeReservationType: + description: 'Specifies the type of reservation from which this instance + can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, + or NO_RESERVATION. See Consuming reserved instances for examples.' + enum: + - ANY_RESERVATION + - NO_RESERVATION + - SPECIFIC_RESERVATION + - UNSPECIFIED + type: string + key: + description: Corresponds to the label key of a reservation resource. To + target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name + as the key and specify the name of your reservation as its value. + type: string + values: + description: Corresponds to the label values of a reservation resource. + This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" + to target a shared reservation in the same zone but in a different project. + items: + type: string + type: array + type: object + ReservationAggregatedList: + description: Contains a list of reservations. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/ReservationsScopedList' + description: Name of the scope containing this set of reservations. + description: A list of Allocation resources. + type: object + kind: + default: compute#reservationAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ReservationList: + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + description: '[Output Only] A list of Allocation resources.' + items: + $ref: '#/components/schemas/Reservation' + type: array + kind: + default: compute#reservationList + description: '[Output Only] Type of resource.Always compute#reservationsList + for listsof reservations' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ReservationsResizeRequest: + properties: + specificSkuCount: + description: Number of allocated resources can be resized with minimum = + 1 and maximum = 1000. + format: int64 + type: string + type: object + ReservationsScopedList: + properties: + reservations: + description: A list of reservations contained in this scope. + items: + $ref: '#/components/schemas/Reservation' + type: array + warning: + description: Informational warning which replaces the list of reservations + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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). + 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 and MEMORY + enum: + - ACCELERATOR + - LOCAL_SSD + - MEMORY + - UNSPECIFIED + - VCPU + type: string + type: object + 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: + properties: + resourcePolicies: + description: A list of resourcePolicies contained in this scope. + items: + $ref: '#/components/schemas/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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ResourcePolicy: + description: Represents a Resource Policy resource. You can use resource policies + to schedule actions for some Compute Engine resources. For example, you can + use them to schedule persistent disk snapshots. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + type: string + groupPlacementPolicy: + $ref: '#/components/schemas/ResourcePolicyGroupPlacementPolicy' + description: Resource policy for instances for placement configuration. + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + instanceSchedulePolicy: + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicy' + description: Resource policy for scheduling instance operations. + kind: + default: compute#resourcePolicy + description: '[Output Only] Type of the resource. Always compute#resource_policies + for resource policies.' + type: string + name: + description: The name of the resource, provided by the client when initially + creating the resource. The resource 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 + region: + type: string + resourceStatus: + $ref: '#/components/schemas/ResourcePolicyResourceStatus' + description: '[Output Only] The system status of the resource policy.' + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this + resource.' + type: string + snapshotSchedulePolicy: + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicy' + description: Resource policy for persistent disks for creating snapshots. + status: + description: '[Output Only] The status of resource policy creation.' + enum: + - CREATING + - DELETING + - EXPIRED + - INVALID + - READY + type: string + type: object + ResourcePolicyAggregatedList: + description: Contains a list of resourcePolicies. + properties: + etag: + type: string + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/ResourcePoliciesScopedList' + description: Name of the scope containing this set of resourcePolicies. + description: A list of ResourcePolicy resources. + type: object + kind: + default: compute#resourcePolicyAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ResourcePolicyDailyCycle: + description: Time window specified for daily operations. + properties: + daysInCycle: + description: Defines a schedule with units measured in months. The value + determines how many months pass between the start of each cycle. + format: int32 + type: integer + duration: + description: '[Output only] A predetermined duration for the window, automatically + chosen to be the smallest possible in the given scenario.' + type: string + startTime: + description: Start time of the window. This must be in UTC format that resolves + to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both + 13:00-5 and 08:00 are valid. + type: string + type: object + ResourcePolicyGroupPlacementPolicy: + description: A GroupPlacementPolicy specifies resource placement configuration. + It specifies the failure bucket separation as well as network locality + properties: + availabilityDomainCount: + description: The number of availability domains instances will be spread + across. If two instances are in different availability domain, they will + not be put in the same low latency network + format: int32 + type: integer + collocation: + description: Specifies network collocation + enum: + - COLLOCATED + - UNSPECIFIED_COLLOCATION + type: string + vmCount: + description: Number of vms in this placement group + format: int32 + type: integer + type: object + ResourcePolicyHourlyCycle: + description: Time window specified for hourly operations. + properties: + duration: + description: '[Output only] Duration of the time window, automatically chosen + to be smallest possible in the given scenario.' + type: string + hoursInCycle: + description: Defines a schedule with units measured in hours. The value + determines how many hours pass between the start of each cycle. + format: int32 + type: integer + startTime: + description: 'Time within the window to start the operations. It must be + in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.' + type: string + type: object + ResourcePolicyInstanceSchedulePolicy: + description: An InstanceSchedulePolicy specifies when and how frequent certain + operations are performed on the instance. + properties: + expirationTime: + description: The expiration time of the schedule. The timestamp is an RFC3339 + string. + type: string + startTime: + description: The start time of the schedule. The timestamp is an RFC3339 + string. + type: string + timeZone: + description: 'Specifies the time zone to be used in interpreting Schedule.schedule. + The value of this field must be a time zone name from the tz database: + http://en.wikipedia.org/wiki/Tz_database.' + type: string + vmStartSchedule: + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicySchedule' + description: Specifies the schedule for starting instances. + vmStopSchedule: + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicySchedule' + description: Specifies the schedule for stopping instances. + type: object + ResourcePolicyInstanceSchedulePolicySchedule: + description: Schedule for an instance operation. + properties: + schedule: + description: Specifies the frequency for the operation, using the unix-cron + format. + type: string + type: object + ResourcePolicyList: + properties: + etag: + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + description: '[Output Only] A list of ResourcePolicy resources.' + items: + $ref: '#/components/schemas/ResourcePolicy' + type: array + kind: + default: compute#resourcePolicyList + description: '[Output Only] Type of resource.Always compute#resourcePoliciesList + for listsof resourcePolicies' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ResourcePolicyResourceStatus: + description: Contains output only fields. Use this sub-message for all output + fields set on ResourcePolicy. The internal structure of this "status" field + should mimic the structure of ResourcePolicy proto specification. + properties: + instanceSchedulePolicy: + $ref: '#/components/schemas/ResourcePolicyResourceStatusInstanceSchedulePolicyStatus' + description: '[Output Only] Specifies a set of output values reffering to + the instance_schedule_policy system status. This field should have the + same name as corresponding policy field.' + type: object + ResourcePolicyResourceStatusInstanceSchedulePolicyStatus: + properties: + lastRunStartTime: + description: '[Output Only] The last time the schedule successfully ran. + The timestamp is an RFC3339 string.' + type: string + nextRunStartTime: + description: '[Output Only] The next time the schedule is planned to run. + The actual time might be slightly different. The timestamp is an RFC3339 + string.' + type: string + type: object + ResourcePolicySnapshotSchedulePolicy: + description: A snapshot schedule policy specifies when and how frequently snapshots + are to be created for the target disk. Also specifies how many and how long + these scheduled snapshots should be retained. + properties: + retentionPolicy: + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicyRetentionPolicy' + description: Retention policy applied to snapshots created by this resource + policy. + schedule: + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicySchedule' + description: A Vm Maintenance Policy specifies what kind of infrastructure + maintenance we are allowed to perform on this VM and when. Schedule that + is applied to disks covered by this policy. + snapshotProperties: + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicySnapshotProperties' + description: Properties with which snapshots are created such as labels, + encryption keys. + type: object + ResourcePolicySnapshotSchedulePolicyRetentionPolicy: + description: Policy for retention of scheduled snapshots. + properties: + maxRetentionDays: + description: Maximum age of the snapshot that is allowed to be kept. + format: int32 + type: integer + onSourceDiskDelete: + description: Specifies the behavior to apply to scheduled snapshots when + the source disk is deleted. + enum: + - APPLY_RETENTION_POLICY + - KEEP_AUTO_SNAPSHOTS + - UNSPECIFIED_ON_SOURCE_DISK_DELETE + type: string + type: object + ResourcePolicySnapshotSchedulePolicySchedule: + description: A schedule for disks where the schedueled operations are performed. + properties: + dailySchedule: + $ref: '#/components/schemas/ResourcePolicyDailyCycle' + hourlySchedule: + $ref: '#/components/schemas/ResourcePolicyHourlyCycle' + weeklySchedule: + $ref: '#/components/schemas/ResourcePolicyWeeklyCycle' + type: object + ResourcePolicySnapshotSchedulePolicySnapshotProperties: + description: Specified snapshot properties for scheduled snapshots created by + this policy. + properties: + chainName: + description: Chain name that the snapshot is created in. + type: string + guestFlush: + description: Indication to perform a 'guest aware' snapshot. + type: boolean + labels: + additionalProperties: + type: string + description: Labels to apply to scheduled snapshots. These can be later + modified by the setLabels method. Label values may be empty. + type: object + storageLocations: + description: Cloud Storage bucket storage location of the auto snapshot + (regional or multi-regional). + items: + type: string + type: array + type: object + ResourcePolicyWeeklyCycle: + description: Time window specified for weekly operations. + properties: + dayOfWeeks: + description: Up to 7 intervals/windows, one for each day of the week. + items: + $ref: '#/components/schemas/ResourcePolicyWeeklyCycleDayOfWeek' + type: array + type: object + ResourcePolicyWeeklyCycleDayOfWeek: + properties: + day: + description: 'Defines a schedule that runs on specific days of the week. + Specify one or more days. The following options are available: MONDAY, + TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.' + enum: + - FRIDAY + - INVALID + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY + type: string + duration: + description: '[Output only] Duration of the time window, automatically chosen + to be smallest possible in the given scenario.' + type: string + startTime: + description: 'Time within the window to start the operations. It must be + in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.' + type: string + type: object + Route: + description: Represents a Route resource. A route defines a path from VM instances + in the VPC network to a specific destination. This destination can be inside + or outside the VPC network. For more information, read the Routes overview. + properties: + asPaths: + description: '[Output Only] AS path.' + items: + $ref: '#/components/schemas/RouteAsPath' + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this field + when you create the resource. + type: string + destRange: + description: The destination range of outgoing packets that this route applies + to. Both IPv4 and IPv6 are supported. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#route + description: '[Output Only] Type of this resource. Always compute#routes + for Route resources.' + type: string + name: + description: 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])?`. The first character must be a + lowercase letter, and all following characters (except for the last character) + must be a dash, lowercase letter, or digit. The last character must be + a lowercase letter or digit. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: Fully-qualified URL of the network that this route applies + to. + type: string + nextHopGateway: + description: 'The URL to a gateway that should handle matching packets. + You can only specify the internet gateway using a full or partial valid + URL: projects/ project/global/gateways/default-internet-gateway' + type: string + nextHopIlb: + description: 'The URL to a forwarding rule of type loadBalancingScheme=INTERNAL + that should handle matching packets or the IP address of the forwarding + Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region + /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule ' + type: string + nextHopInstance: + description: 'The URL to an instance that should handle matching packets. + You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/' + type: string + nextHopIp: + description: The network IP address of an instance that should handle matching + packets. Only IPv4 is supported. + type: string + nextHopNetwork: + description: The URL of the local network if it should handle matching packets. + type: string + nextHopPeering: + description: '[Output Only] The network peering name that should handle + matching packets, which should conform to RFC1035.' + type: string + nextHopVpnTunnel: + description: The URL to a VpnTunnel that should handle matching packets. + type: string + priority: + description: The priority of this route. Priority is used to break ties + in cases where there is more than one matching route of equal prefix length. + In cases where multiple routes have equal prefix length, the one with + the lowest-numbered priority value wins. The default value is `1000`. + The priority value must be from `0` to `65535`, inclusive. + format: uint32 + type: integer + routeType: + description: '[Output Only] The type of this route, which can be one of + the following values: - ''TRANSIT'' for a transit route that this router + learned from another Cloud Router and will readvertise to one of its BGP + peers - ''SUBNET'' for a route from a subnet of the VPC - ''BGP'' for + a route learned from a BGP peer of this router - ''STATIC'' for a static + route' + enum: + - BGP + - STATIC + - SUBNET + - TRANSIT + type: string + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this + resource.' + type: string + tags: + description: A list of instance tags to which this route applies. + items: + type: string + type: array + warnings: + description: '[Output Only] If potential misconfigurations are detected + for this route, this field will be populated with warning messages.' + items: + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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: array + type: object + RouteAsPath: + properties: + asLists: + description: '[Output Only] The AS numbers of the AS Path.' + items: + format: uint32 + type: integer + type: array + pathSegmentType: + description: '[Output Only] The type of the AS Path, which can be one of + the following values: - ''AS_SET'': unordered set of autonomous systems + that the route in has traversed - ''AS_SEQUENCE'': ordered set of autonomous + systems that the route has traversed - ''AS_CONFED_SEQUENCE'': ordered + set of Member Autonomous Systems in the local confederation that the route + has traversed - ''AS_CONFED_SET'': unordered set of Member Autonomous + Systems in the local confederation that the route has traversed ' + enum: + - AS_CONFED_SEQUENCE + - AS_CONFED_SET + - AS_SEQUENCE + - AS_SET + type: string + type: object + RouteList: + description: Contains a list of Route resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Route resources. + items: + $ref: '#/components/schemas/Route' + type: array + kind: + default: compute#routeList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Router: + description: Represents a Cloud Router resource. For more information about + Cloud Router, read the Cloud Router overview. + properties: + bgp: + $ref: '#/components/schemas/RouterBgp' + description: BGP information specific to this router. + bgpPeers: + description: BGP information that must be configured into the routing stack + to establish BGP peering. This information must specify the peer ASN and + either the interface name, IP address, or peer IP address. Please refer + to RFC4273. + items: + $ref: '#/components/schemas/RouterBgpPeer' + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + encryptedInterconnectRouter: + description: 'Indicates if a router is dedicated for use with encrypted + VLAN attachments (interconnectAttachments). Not currently available publicly. ' + type: boolean + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + interfaces: + description: Router interfaces. Each interface requires either one linked + resource, (for example, linkedVpnTunnel), or IP address and IP address + range (for example, ipRange), or both. + items: + $ref: '#/components/schemas/RouterInterface' + type: array + kind: + default: compute#router + description: '[Output Only] Type of resource. Always compute#router for + routers.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + nats: + description: A list of NAT services created in this router. + items: + $ref: '#/components/schemas/RouterNat' + type: array + network: + description: URI of the network to which this router belongs. + type: string + region: + description: '[Output Only] URI of the region where the router resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + RouterAdvertisedIpRange: + description: Description-tagged IP ranges for the router to advertise. + properties: + description: + description: User-specified description for the IP range. + type: string + range: + description: The IP range to advertise. The value must be a CIDR-formatted + string. + type: string + type: object + RouterAggregatedList: + description: Contains a list of routers. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/RoutersScopedList' + description: Name of the scope containing this set of routers. + description: A list of Router resources. + type: object + kind: + default: compute#routerAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RouterBgp: + properties: + advertiseMode: + description: User-specified flag to indicate which mode to use for advertisement. + The options are DEFAULT or CUSTOM. + enum: + - CUSTOM + - DEFAULT + type: string + advertisedGroups: + description: User-specified list of prefix groups to advertise in custom + mode. This field can only be populated if advertise_mode is CUSTOM and + is advertised to all peers of the router. These groups will be advertised + in addition to any specified prefixes. Leave this field blank to advertise + no custom groups. + items: + enum: + - ALL_SUBNETS + type: string + type: array + advertisedIpRanges: + description: User-specified list of individual IP ranges to advertise in + custom mode. This field can only be populated if advertise_mode is CUSTOM + and is advertised to all peers of the router. These IP ranges will be + advertised in addition to any specified groups. Leave this field blank + to advertise no custom IP ranges. + items: + $ref: '#/components/schemas/RouterAdvertisedIpRange' + type: array + asn: + description: Local BGP Autonomous System Number (ASN). Must be an RFC6996 + private ASN, either 16-bit or 32-bit. The value will be fixed for this + router resource. All VPN tunnels that link to this router will have the + same local ASN. + format: uint32 + type: integer + keepaliveInterval: + description: The interval in seconds between BGP keepalive messages that + are sent to the peer. Hold time is three times the interval at which keepalive + messages are sent, and the hold time is the maximum number of seconds + allowed to elapse between successive keepalive messages that BGP receives + from a peer. BGP will use the smaller of either the local hold time value + or the peer's hold time value as the hold time for the BGP connection + between the two peers. If set, this value must be between 20 and 60. The + default is 20. + format: uint32 + type: integer + type: object + RouterBgpPeer: + properties: + advertiseMode: + description: User-specified flag to indicate which mode to use for advertisement. + enum: + - CUSTOM + - DEFAULT + type: string + advertisedGroups: + description: 'User-specified list of prefix groups to advertise in custom + mode, which can take one of the following options: - ALL_SUBNETS: Advertises + all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: + Advertises the router''s own VPC subnets. Note that this field can only + be populated if advertise_mode is CUSTOM and overrides the list defined + for the router (in the "bgp" message). These groups are advertised in + addition to any specified prefixes. Leave this field blank to advertise + no custom groups.' + items: + enum: + - ALL_SUBNETS + type: string + type: array + advertisedIpRanges: + description: User-specified list of individual IP ranges to advertise in + custom mode. This field can only be populated if advertise_mode is CUSTOM + and overrides the list defined for the router (in the "bgp" message). + These IP ranges are advertised in addition to any specified groups. Leave + this field blank to advertise no custom IP ranges. + items: + $ref: '#/components/schemas/RouterAdvertisedIpRange' + type: array + advertisedRoutePriority: + description: The priority of routes advertised to this BGP peer. Where there + is more than one matching route of maximum length, the routes with the + lowest priority value win. + format: uint32 + type: integer + bfd: + $ref: '#/components/schemas/RouterBgpPeerBfd' + description: BFD configuration for the BGP peering. + enable: + description: The status of the BGP peer connection. If set to FALSE, any + active session with the peer is terminated and all associated routing + information is removed. If set to TRUE, the peer connection can be established + with routing information. The default is TRUE. + enum: + - 'FALSE' + - 'TRUE' + type: string + interfaceName: + description: Name of the interface the BGP peer is associated with. + type: string + ipAddress: + description: IP address of the interface inside Google Cloud Platform. Only + IPv4 is supported. + type: string + managementType: + description: '[Output Only] The resource that configures and manages this + BGP peer. - MANAGED_BY_USER is the default value and can be managed by + you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured + and managed by Cloud Interconnect, specifically by an InterconnectAttachment + of type PARTNER. Google automatically creates, updates, and deletes this + type of BGP peer when the PARTNER InterconnectAttachment is created, updated, + or deleted. ' + enum: + - MANAGED_BY_ATTACHMENT + - MANAGED_BY_USER + type: string + name: + description: Name of this BGP peer. 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 + peerAsn: + description: Peer BGP Autonomous System Number (ASN). Each BGP interface + may use a different value. + format: uint32 + type: integer + peerIpAddress: + description: IP address of the BGP interface outside Google Cloud Platform. + Only IPv4 is supported. + type: string + routerApplianceInstance: + description: URI of the VM instance that is used as third-party router appliances + such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The + VM instance must be located in zones contained in the same region as this + Cloud Router. The VM instance is the peer side of the BGP session. + type: string + type: object + RouterBgpPeerBfd: + properties: + minReceiveInterval: + description: The minimum interval, in milliseconds, between BFD control + packets received from the peer router. The actual value is negotiated + between the two routers and is equal to the greater of this value and + the transmit interval of the other router. If set, this value must be + between 1000 and 30000. The default is 1000. + format: uint32 + type: integer + minTransmitInterval: + description: The minimum interval, in milliseconds, between BFD control + packets transmitted to the peer router. The actual value is negotiated + between the two routers and is equal to the greater of this value and + the corresponding receive interval of the other router. If set, this value + must be between 1000 and 30000. The default is 1000. + format: uint32 + type: integer + multiplier: + description: The number of consecutive BFD packets that must be missed before + BFD declares that a peer is unavailable. If set, the value must be a value + between 5 and 16. The default is 5. + format: uint32 + type: integer + sessionInitializationMode: + description: The BFD session initialization mode for this BGP peer. If set + to ACTIVE, the Cloud Router will initiate the BFD session for this BGP + peer. If set to PASSIVE, the Cloud Router will wait for the peer router + to initiate the BFD session for this BGP peer. If set to DISABLED, BFD + is disabled for this BGP peer. The default is PASSIVE. + enum: + - ACTIVE + - DISABLED + - PASSIVE + type: string + type: object + RouterInterface: + properties: + ipRange: + description: 'IP address and range of the interface. The IP range must be + in the RFC3927 link-local IP address space. The value must be a CIDR-formatted + string, for example: 169.254.0.1/30. NOTE: Do not truncate the address + as it represents the IP address of the interface.' + type: string + linkedInterconnectAttachment: + description: URI of the linked Interconnect attachment. It must be in the + same region as the router. Each interface can have one linked resource, + which can be a VPN tunnel, an Interconnect attachment, or a virtual machine + instance. + type: string + linkedVpnTunnel: + description: URI of the linked VPN tunnel, which must be in the same region + as the router. Each interface can have one linked resource, which can + be a VPN tunnel, an Interconnect attachment, or a virtual machine instance. + type: string + managementType: + description: '[Output Only] The resource that configures and manages this + interface. - MANAGED_BY_USER is the default value and can be managed directly + by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and + managed by Cloud Interconnect, specifically, by an InterconnectAttachment + of type PARTNER. Google automatically creates, updates, and deletes this + type of interface when the PARTNER InterconnectAttachment is created, + updated, or deleted. ' + enum: + - MANAGED_BY_ATTACHMENT + - MANAGED_BY_USER + type: string + name: + description: Name of this interface entry. 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 + privateIpAddress: + description: The regional private internal IP address that is used to establish + BGP sessions to a VM instance acting as a third-party Router Appliance, + such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM. + type: string + redundantInterface: + description: Name of the interface that will be redundant with the current + interface you are creating. The redundantInterface must belong to the + same Cloud Router as the interface here. To establish the BGP session + to a Router Appliance VM, you must create two BGP peers. The two BGP peers + must be attached to two separate interfaces that are redundant with each + other. The redundant_interface must be 1-63 characters long, and comply + with RFC1035. Specifically, the redundant_interface 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 + subnetwork: + description: The URI of the subnetwork resource that this interface belongs + to, which must be in the same region as the Cloud Router. When you establish + a BGP session to a VM instance using this interface, the VM instance must + belong to the same subnetwork as the subnetwork specified here. + type: string + type: object + RouterList: + description: Contains a list of Router resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Router resources. + items: + $ref: '#/components/schemas/Router' + type: array + kind: + default: compute#routerList + description: '[Output Only] Type of resource. Always compute#router for + routers.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + RouterNat: + description: Represents a Nat resource. It enables the VMs within the specified + subnetworks to access Internet without external IP addresses. It specifies + a list of subnetworks (and the ranges within) that want to use NAT. Customers + can also provide the external IPs that would be used for NAT. GCP would auto-allocate + ephemeral IPs if no external IPs are provided. + properties: + drainNatIps: + 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 only. + items: + type: string + type: array + enableEndpointIndependentMapping: + type: boolean + icmpIdleTimeoutSec: + description: Timeout (in seconds) for ICMP connections. Defaults to 30s + if not set. + format: int32 + type: integer + logConfig: + $ref: '#/components/schemas/RouterNatLogConfig' + description: Configure logging on this NAT. + minPortsPerVm: + description: Minimum number of ports allocated to a VM from this NAT config. + If not set, a default number of ports is allocated to a VM. This is rounded + up to the nearest power of 2. For example, if the value of this field + is 50, at least 64 ports are allocated to a VM. + format: int32 + type: integer + name: + description: Unique name of this Nat service. 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 + natIpAllocateOption: + description: 'Specify the NatIpAllocateOption, which can take one of the + following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by + customers. When there are not enough specified Nat IPs, the Nat service + fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud + Platform; customers can''t specify any Nat IPs. When choosing AUTO_ONLY, + then nat_ip should be empty. ' + enum: + - AUTO_ONLY + - MANUAL_ONLY + type: string + natIps: + description: A list of URLs of the IP resources used for this Nat service. + These IP addresses must be valid static external IP addresses assigned + to the project. + items: + type: string + type: array + rules: + description: A list of rules associated with this NAT. + items: + $ref: '#/components/schemas/RouterNatRule' + type: array + sourceSubnetworkIpRangesToNat: + description: 'Specify the Nat option, which can take one of the following + values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every + Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: + All of the primary IP ranges in every Subnetwork are allowed to Nat. - + LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified + in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. + Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, + then there should not be any other Router.Nat section in any Router for + this network in this region.' + enum: + - ALL_SUBNETWORKS_ALL_IP_RANGES + - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES + - LIST_OF_SUBNETWORKS + type: string + subnetworks: + description: A list of Subnetwork resources whose traffic should be translated + by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for + the SubnetworkIpRangeToNatOption above. + items: + $ref: '#/components/schemas/RouterNatSubnetworkToNat' + type: array + tcpEstablishedIdleTimeoutSec: + description: Timeout (in seconds) for TCP established connections. Defaults + to 1200s if not set. + format: int32 + type: integer + tcpTimeWaitTimeoutSec: + description: Timeout (in seconds) for TCP connections that are in TIME_WAIT + state. Defaults to 120s if not set. + format: int32 + type: integer + tcpTransitoryIdleTimeoutSec: + description: Timeout (in seconds) for TCP transitory connections. Defaults + to 30s if not set. + format: int32 + type: integer + udpIdleTimeoutSec: + description: Timeout (in seconds) for UDP connections. Defaults to 30s if + not set. + format: int32 + type: integer + type: object + RouterNatLogConfig: + description: Configuration of logging on a NAT. + properties: + enable: + description: Indicates whether or not to export logs. This is false by default. + type: boolean + filter: + description: 'Specify the desired filtering of logs on this NAT. If unspecified, + logs are exported for all connections handled by this NAT. This option + can take one of the following values: - ERRORS_ONLY: Export logs only + for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful + connections. - ALL: Export logs for all connections, successful and unsuccessful. ' + enum: + - ALL + - ERRORS_ONLY + - TRANSLATIONS_ONLY + type: string + type: object + RouterNatRule: + properties: + action: + $ref: '#/components/schemas/RouterNatRuleAction' + description: The action to be enforced for traffic that matches this rule. + description: + description: An optional description of this rule. + type: string + match: + description: '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 + == ''/projects/my-project/global/hub/hub-1''"' + type: string + ruleNumber: + description: An integer uniquely identifying a rule in the list. The rule + number must be a positive value between 0 and 65000, and must be unique + among rules within a NAT. + format: uint32 + type: integer + type: object + RouterNatRuleAction: + properties: + sourceNatActiveIps: + description: 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. + 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 + type: object + RouterNatSubnetworkToNat: + description: Defines the IP ranges that want to use NAT for a subnetwork. + properties: + name: + description: URL for the subnetwork resource that will use NAT. + type: string + secondaryIpRangeNames: + description: A list of the secondary ranges of the Subnetwork that are allowed + to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" + is one of the values in source_ip_ranges_to_nat. + items: + type: string + type: array + sourceIpRangesToNat: + description: 'Specify the options for NAT ranges in the Subnetwork. All + options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. + The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] + Default: [ALL_IP_RANGES]' + items: + enum: + - ALL_IP_RANGES + - LIST_OF_SECONDARY_IP_RANGES + - PRIMARY_IP_RANGE + type: string + type: array + type: object + RouterStatus: + properties: + bestRoutes: + description: Best routes for this router's network. + items: + $ref: '#/components/schemas/Route' + type: array + bestRoutesForRouter: + description: Best routes learned by this router. + items: + $ref: '#/components/schemas/Route' + type: array + bgpPeerStatus: + items: + $ref: '#/components/schemas/RouterStatusBgpPeerStatus' + type: array + natStatus: + items: + $ref: '#/components/schemas/RouterStatusNatStatus' + type: array + network: + description: URI of the network to which this router belongs. + type: string + type: object + RouterStatusBgpPeerStatus: + properties: + advertisedRoutes: + description: Routes that were advertised to the remote BGP peer + items: + $ref: '#/components/schemas/Route' + type: array + bfdStatus: + $ref: '#/components/schemas/BfdStatus' + ipAddress: + description: IP address of the local BGP interface. + type: string + linkedVpnTunnel: + description: URL of the VPN tunnel that this BGP peer controls. + type: string + name: + description: Name of this BGP peer. Unique within the Routers resource. + type: string + numLearnedRoutes: + description: Number of routes learned from the remote BGP Peer. + format: uint32 + type: integer + peerIpAddress: + description: IP address of the remote BGP interface. + type: string + routerApplianceInstance: + description: '[Output only] URI of the VM instance that is used as third-party + router appliances such as Next Gen Firewalls, Virtual Routers, or Router + Appliances. The VM instance is the peer side of the BGP session.' + type: string + state: + description: BGP state as specified in RFC1771. + type: string + status: + description: 'Status of the BGP peer: {UP, DOWN}' + enum: + - DOWN + - UNKNOWN + - UP + type: string + uptime: + description: 'Time this session has been up. Format: 14 years, 51 weeks, + 6 days, 23 hours, 59 minutes, 59 seconds' + type: string + uptimeSeconds: + description: 'Time this session has been up, in seconds. Format: 145' + type: string + type: object + RouterStatusNatStatus: + description: Status of a NAT contained in this router. + properties: + autoAllocatedNatIps: + description: 'A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", + "129.2.16.89"]' + items: + type: string + type: array + drainAutoAllocatedNatIps: + description: 'A list of IPs auto-allocated for NAT that are in drain mode. + Example: ["1.1.1.1", "179.12.26.133"].' + items: + type: string + type: array + drainUserAllocatedNatIps: + description: 'A list of IPs user-allocated for NAT that are in drain mode. + Example: ["1.1.1.1", "179.12.26.133"].' + items: + type: string + type: array + minExtraNatIpsNeeded: + description: The number of extra IPs to allocate. This will be greater than + 0 only if user-specified IPs are NOT enough to allow all configured VMs + to use NAT. This value is meaningful only when auto-allocation of NAT + IPs is *not* used. + format: int32 + type: integer + name: + description: Unique name of this NAT. + type: string + numVmEndpointsWithNatMappings: + description: Number of VM endpoints (i.e., Nics) that can use NAT. + format: int32 + type: integer + ruleStatus: + description: Status of rules in this NAT. + items: + $ref: '#/components/schemas/RouterStatusNatStatusNatRuleStatus' + type: array + userAllocatedNatIpResources: + description: A list of fully qualified URLs of reserved IP address resources. + items: + type: string + type: array + userAllocatedNatIps: + description: A list of IPs user-allocated for NAT. They will be raw IP strings + like "179.12.26.133". + items: + type: string + type: array + type: object + RouterStatusNatStatusNatRuleStatus: + description: Status of a NAT Rule contained in this NAT. + properties: + activeNatIps: + description: 'A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].' + items: + type: string + type: array + drainNatIps: + description: 'A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", + "179.12.26.133"].' + items: + type: string + type: array + minExtraIpsNeeded: + description: The number of extra IPs to allocate. This will be greater than + 0 only if the existing IPs in this NAT Rule are NOT enough to allow all + configured VMs to use NAT. + format: int32 + type: integer + numVmEndpointsWithNatMappings: + description: Number of VM endpoints (i.e., NICs) that have NAT Mappings + from this NAT Rule. + format: int32 + type: integer + ruleNumber: + description: Rule number of the rule. + format: int32 + type: integer + type: object + RouterStatusResponse: + properties: + kind: + default: compute#routerStatusResponse + description: Type of resource. + type: string + result: + $ref: '#/components/schemas/RouterStatus' + type: object + RoutersPreviewResponse: + properties: + resource: + $ref: '#/components/schemas/Router' + description: Preview of given router. + type: object + RoutersScopedList: + properties: + routers: + description: A list of routers contained in this scope. + items: + $ref: '#/components/schemas/Router' + type: array + warning: + description: Informational warning which replaces the list of routers 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + Rule: + description: This is deprecated and has no effect. Do not use. + properties: + action: + description: This is deprecated and has no effect. Do not use. + enum: + - ALLOW + - ALLOW_WITH_LOG + - DENY + - DENY_WITH_LOG + - LOG + - NO_ACTION + type: string + conditions: + description: This is deprecated and has no effect. Do not use. + items: + $ref: '#/components/schemas/Condition' + type: array + description: + description: This is deprecated and has no effect. Do not use. + type: string + ins: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + logConfigs: + description: This is deprecated and has no effect. Do not use. + items: + $ref: '#/components/schemas/LogConfig' + type: array + notIns: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + permissions: + description: This is deprecated and has no effect. Do not use. + items: + type: string + type: array + type: object + SSLHealthCheck: + properties: + port: + description: The TCP port number for the health check request. The default + value is 443. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, SSL health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + request: + description: The application data to send once the SSL connection has been + established (default value is empty). If both request and response are + empty, the connection establishment alone will indicate health. The request + data can only be ASCII. + type: string + response: + description: The bytes to match against the beginning of the response data. + If left empty (the default value), any response will indicate health. + The response data can only be ASCII. + type: string + type: object + ScalingScheduleStatus: + properties: + lastStartTime: + description: '[Output Only] The last time the scaling schedule became active. + Note: this is a timestamp when a schedule actually became active, not + when it was planned to do so. The timestamp is in RFC3339 text format.' + type: string + nextStartTime: + description: '[Output Only] The next time the scaling schedule is to become + active. Note: this is a timestamp when a schedule is planned to run, but + the actual time might be slightly different. The timestamp is in RFC3339 + text format.' + type: string + state: + description: '[Output Only] The current state of a scaling schedule.' + enum: + - ACTIVE + - DISABLED + - OBSOLETE + - READY + type: string + type: object + Scheduling: + description: 'Sets the scheduling options for an Instance. NextID: 21' + properties: + automaticRestart: + description: Specifies whether the instance should be automatically restarted + if it is terminated by Compute Engine (not terminated by a user). You + can only set the automatic restart option for standard instances. Preemptible + instances cannot be automatically restarted. By default, this is set to + true so an instance is automatically restarted if it is terminated by + Compute Engine. + type: boolean + locationHint: + description: An opaque location hint used to place the instance close to + other resources. This field is for use by internal tools that use the + public API. + type: string + minNodeCpus: + description: The minimum number of virtual CPUs this instance will consume + when running on a sole-tenant node. + format: int32 + type: integer + nodeAffinities: + description: A set of node affinity and anti-affinity configurations. Refer + to Configuring node affinity for more information. Overrides reservationAffinity. + items: + $ref: '#/components/schemas/SchedulingNodeAffinity' + type: array + onHostMaintenance: + description: Defines the maintenance behavior for this instance. For standard + instances, the default behavior is MIGRATE. For preemptible instances, + the default and only possible behavior is TERMINATE. For more information, + see Setting Instance Scheduling Options. + enum: + - MIGRATE + - TERMINATE + type: string + preemptible: + description: Defines whether the instance is preemptible. This can only + be set during instance creation or while the instance is stopped and therefore, + in a `TERMINATED` state. See Instance Life Cycle for more information + on the possible instance states. + type: boolean + type: object + SchedulingNodeAffinity: + description: 'Node Affinity: the configuration of desired nodes onto which this + Instance could be scheduled.' + properties: + key: + description: Corresponds to the label key of Node resource. + type: string + operator: + description: Defines the operation of node selection. Valid operators are + IN for affinity and NOT_IN for anti-affinity. + enum: + - IN + - NOT_IN + - OPERATOR_UNSPECIFIED + type: string + values: + description: Corresponds to the label values of Node resource. + items: + type: string + type: array + type: object + Screenshot: + description: An instance's screenshot. + properties: + contents: + description: '[Output Only] The Base64-encoded screenshot data.' + type: string + kind: + default: compute#screenshot + description: '[Output Only] Type of the resource. Always compute#screenshot + for the screenshots.' + type: string + type: object + SecurityPoliciesListPreconfiguredExpressionSetsResponse: + properties: + preconfiguredExpressionSets: + $ref: '#/components/schemas/SecurityPoliciesWafConfig' + type: object + SecurityPoliciesWafConfig: + properties: + wafRules: + $ref: '#/components/schemas/PreconfiguredWafSet' + type: object + SecurityPolicy: + description: Represents a Google Cloud Armor security policy resource. Only + external backend services that use load balancers can reference a security + policy. For more information, see Google Cloud Armor security policy overview. + properties: + adaptiveProtectionConfig: + $ref: '#/components/schemas/SecurityPolicyAdaptiveProtectionConfig' + advancedOptionsConfig: + $ref: '#/components/schemas/SecurityPolicyAdvancedOptionsConfig' + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Specifies a fingerprint for this resource, which is essentially + a hash of the metadata's contents and used for optimistic locking. The + fingerprint is initially generated by Compute Engine and changes after + every request to modify or update metadata. You must always provide an + up-to-date fingerprint hash in order to update or change metadata, otherwise + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make get() request to the security policy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#securityPolicy + description: '[Output only] Type of the resource. Always compute#securityPolicyfor + security policies' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + rules: + description: A list of rules that belong to this policy. There must always + be a default rule (rule with priority 2147483647 and match "*"). If no + rules are provided when creating a security policy, a default rule with + action "allow" will be added. + items: + $ref: '#/components/schemas/SecurityPolicyRule' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + type: object + SecurityPolicyAdaptiveProtectionConfig: + description: Configuration options for Cloud Armor Adaptive Protection (CAAP). + properties: + layer7DdosDefenseConfig: + $ref: '#/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig' + description: If set to true, enables Cloud Armor Machine Learning. + type: object + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig: + description: Configuration options for L7 DDoS detection. + properties: + enable: + description: If set to true, enables CAAP for L7 DDoS detection. + type: boolean + ruleVisibility: + description: 'Rule visibility can be one of the following: STANDARD - opaque + rules. (default) PREMIUM - transparent rules.' + enum: + - PREMIUM + - STANDARD + type: string + type: object + SecurityPolicyAdvancedOptionsConfig: + properties: + jsonParsing: + enum: + - DISABLED + - STANDARD + type: string + logLevel: + enum: + - NORMAL + - VERBOSE + type: string + type: object + SecurityPolicyList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of SecurityPolicy resources. + items: + $ref: '#/components/schemas/SecurityPolicy' + type: array + kind: + default: compute#securityPolicyList + description: '[Output Only] Type of resource. Always compute#securityPolicyList + for listsof securityPolicies' + 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 + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SecurityPolicyReference: + properties: + securityPolicy: + type: string + type: object + SecurityPolicyRule: + description: Represents a rule that describes one or more match conditions along + with the action to be taken when traffic matches this condition (allow or + deny). + properties: + action: + description: The Action to perform when the client connection triggers the + rule. Can currently be either "allow" or "deny()" where valid values for + status are 403, 404, and 502. + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + kind: + default: compute#securityPolicyRule + description: '[Output only] Type of the resource. Always compute#securityPolicyRule + for security policy rules' + type: string + match: + $ref: '#/components/schemas/SecurityPolicyRuleMatcher' + description: A match condition that incoming traffic is evaluated against. + If it evaluates to true, the corresponding 'action' is enforced. + preview: + description: If set to true, the specified action is not enforced. + type: boolean + priority: + description: An integer indicating the priority of a rule in the list. The + priority must be a positive value between 0 and 2147483647. Rules are + evaluated from highest to lowest priority where 0 is the highest priority + and 2147483647 is the lowest priority. + format: int32 + type: integer + type: object + SecurityPolicyRuleMatcher: + description: Represents a match condition that incoming traffic is evaluated + against. Exactly one field must be specified. + properties: + config: + $ref: '#/components/schemas/SecurityPolicyRuleMatcherConfig' + description: The configuration options available when specifying versioned_expr. + This field must be specified if versioned_expr is specified and cannot + be specified if versioned_expr is not specified. + expr: + $ref: '#/components/schemas/Expr' + description: User defined CEVAL expression. A CEVAL expression is used to + specify match criteria such as origin.ip, source.region_code and contents + in the request header. + versionedExpr: + description: 'Preconfigured versioned expression. If this field is specified, + config must also be specified. Available preconfigured expressions along + with their requirements are: SRC_IPS_V1 - must specify the corresponding + src_ip_range field in config.' + enum: + - SRC_IPS_V1 + type: string + type: object + SecurityPolicyRuleMatcherConfig: + properties: + srcIpRanges: + description: CIDR IP address range. Maximum number of src_ip_ranges allowed + is 10. + items: + type: string + type: array + type: object + SecuritySettings: + description: The authentication and authorization settings for a BackendService. + properties: + clientTlsPolicy: + description: 'Optional. A URL referring to a networksecurity.ClientTlsPolicy + resource that describes how clients should authenticate with this service''s + backends. clientTlsPolicy only applies to a global BackendService with + the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications + are not encrypted. Note: This field currently has no impact.' + type: string + subjectAltNames: + description: 'Optional. A list of Subject Alternative Names (SANs) that + the client verifies during a mutual TLS handshake with an server/endpoint + for this BackendService. When the server presents its X.509 certificate + to the client, the client inspects the certificate''s subjectAltName field. + If the field contains one of the specified values, the communication continues. + Otherwise, it fails. This additional check enables the client to verify + that the server is authorized to run the requested service. Note that + the contents of the server certificate''s subjectAltName field are configured + by the Public Key Infrastructure which provisions server identities. Only + applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. + Only applies when BackendService has an attached clientTlsPolicy with + clientCertificate (mTLS mode). Note: This field currently has no impact.' + items: + type: string + type: array + type: object + SerialPortOutput: + description: An instance serial console output. + properties: + contents: + description: '[Output Only] The contents of the console output.' + type: string + kind: + default: compute#serialPortOutput + description: '[Output Only] Type of the resource. Always compute#serialPortOutput + for serial port output.' + type: string + next: + description: '[Output Only] The position of the next byte of content, regardless + of whether the content exists, following the output returned in the `contents` + property. Use this value in the next request as the start parameter.' + format: int64 + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + start: + description: The starting byte position of the output that was returned. + This should match the start parameter sent with the request. If the serial + console output exceeds the size of the buffer (1 MB), older output is + overwritten by newer content. The output start value will indicate the + byte position of the output that was returned, which might be different + than the `start` value that was specified in the request. + format: int64 + type: string + type: object + ServerBinding: + properties: + type: + enum: + - RESTART_NODE_ON_ANY_SERVER + - RESTART_NODE_ON_MINIMAL_SERVERS + - SERVER_BINDING_TYPE_UNSPECIFIED + type: string + type: object + ServiceAccount: + description: A service account. + properties: + email: + description: Email address of the service account. + type: string + scopes: + description: The list of scopes to be made available for this service account. + items: + type: string + type: array + type: object + ServiceAttachment: + description: Represents a ServiceAttachment resource. A service attachment represents + a service that a producer has exposed. It encapsulates the load balancer which + fronts the service runs and a list of NAT IP ranges that the producers uses + to represent the consumers connecting to the service. next tag = 20 + properties: + connectedEndpoints: + description: '[Output Only] An array of connections for all the consumers + connected to this service attachment.' + items: + $ref: '#/components/schemas/ServiceAttachmentConnectedEndpoint' + type: array + connectionPreference: + description: The connection preference of service attachment. The value + can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment + is one that always accepts the connection from consumer forwarding rules. + enum: + - ACCEPT_AUTOMATIC + - ACCEPT_MANUAL + - CONNECTION_PREFERENCE_UNSPECIFIED + type: string + consumerAcceptLists: + description: Projects that are allowed to connect to this service attachment. + items: + $ref: '#/components/schemas/ServiceAttachmentConsumerProjectLimit' + type: array + consumerRejectLists: + description: Projects that are not allowed to connect to this service attachment. + The project can be specified using its id or number. + items: + type: string + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + enableProxyProtocol: + description: If true, enable the proxy protocol which is for supplying client + TCP/IP address data in TCP connections that traverse proxies on their + way to destination servers. + type: boolean + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a ServiceAttachment. An up-to-date fingerprint + must be provided in order to patch/update the ServiceAttachment; otherwise, + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the ServiceAttachment. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource type. + The server generates this identifier.' + format: uint64 + type: string + kind: + default: compute#serviceAttachment + description: '[Output Only] Type of the resource. Always compute#serviceAttachment + for service attachments.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + natSubnets: + description: An array of URLs where each entry is the URL of a subnet provided + by the service producer to use for NAT in this service attachment. + items: + type: string + type: array + producerForwardingRule: + description: The URL of a forwarding rule with loadBalancingScheme INTERNAL* + that is serving the endpoint identified by this service attachment. + type: string + pscServiceAttachmentId: + $ref: '#/components/schemas/Uint128' + description: '[Output Only] An 128-bit global unique ID of the PSC service + attachment.' + region: + description: '[Output Only] URL of the region where the service attachment + resides. This field applies only to the region resource. You must specify + this field as part of the HTTP request URL. It is not settable as a field + in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + targetService: + description: The URL of a service serving the endpoint identified by this + service attachment. + type: string + type: object + ServiceAttachmentAggregatedList: + description: Contains a list of ServiceAttachmentsScopedList. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/ServiceAttachmentsScopedList' + description: Name of the scope containing this set of ServiceAttachments. + description: A list of ServiceAttachmentsScopedList resources. + type: object + kind: + default: compute#serviceAttachmentAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ServiceAttachmentConnectedEndpoint: + description: '[Output Only] A connection connected to this service attachment.' + properties: + endpoint: + description: The url of a connected endpoint. + type: string + pscConnectionId: + description: The PSC connection id of the connected endpoint. + format: uint64 + type: string + status: + description: The status of a connected endpoint to this service attachment. + enum: + - ACCEPTED + - CLOSED + - PENDING + - REJECTED + - STATUS_UNSPECIFIED + type: string + type: object + ServiceAttachmentConsumerProjectLimit: + properties: + connectionLimit: + description: The value of the limit to set. + format: uint32 + type: integer + projectIdOrNum: + description: The project id or number for the project to set the limit for. + type: string + type: object + ServiceAttachmentList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of ServiceAttachment resources. + items: + $ref: '#/components/schemas/ServiceAttachment' + type: array + kind: + default: compute#serviceAttachmentList + description: '[Output Only] Type of the resource. Always compute#serviceAttachment + for service attachments.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ServiceAttachmentsScopedList: + properties: + serviceAttachments: + description: A list of ServiceAttachments contained in this scope. + items: + $ref: '#/components/schemas/ServiceAttachment' + type: array + warning: + description: Informational warning which replaces the list of service attachments + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ShareSettings: + description: The share setting for reservations and sole tenancy node groups. + properties: + shareType: + description: Type of sharing for this shared-reservation + enum: + - LOCAL + - SHARE_TYPE_UNSPECIFIED + type: string + type: object + ShieldedInstanceConfig: + description: A set of Shielded Instance options. + properties: + enableIntegrityMonitoring: + description: Defines whether the instance has integrity monitoring enabled. + Enabled by default. + type: boolean + enableSecureBoot: + description: Defines whether the instance has Secure Boot enabled. Disabled + by default. + type: boolean + enableVtpm: + description: Defines whether the instance has the vTPM enabled. Enabled + by default. + type: boolean + type: object + ShieldedInstanceIdentity: + description: A Shielded Instance Identity. + properties: + encryptionKey: + $ref: '#/components/schemas/ShieldedInstanceIdentityEntry' + description: An Endorsement Key (EK) made by the RSA 2048 algorithm issued + to the Shielded Instance's vTPM. + kind: + default: compute#shieldedInstanceIdentity + description: '[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity + for shielded Instance identity entry.' + type: string + signingKey: + $ref: '#/components/schemas/ShieldedInstanceIdentityEntry' + description: An Attestation Key (AK) made by the RSA 2048 algorithm issued + to the Shielded Instance's vTPM. + type: object + ShieldedInstanceIdentityEntry: + description: A Shielded Instance Identity Entry. + properties: + ekCert: + description: A PEM-encoded X.509 certificate. This field can be empty. + type: string + ekPub: + description: A PEM-encoded public key. + type: string + type: object + ShieldedInstanceIntegrityPolicy: + description: The policy describes the baseline against which Instance boot integrity + is measured. + properties: + updateAutoLearnPolicy: + description: Updates the integrity policy baseline using the measurements + from the VM instance's most recent boot. + type: boolean + type: object + SignedUrlKey: + description: Represents a customer-supplied Signing Key used by Cloud CDN Signed + URLs + properties: + keyName: + description: Name of the 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + keyValue: + description: 128-bit key value used for signing the URL. The key value must + be a valid RFC 4648 Section 5 base64url encoded string. + type: string + type: object + Snapshot: + description: Represents a Persistent Disk Snapshot resource. You can use snapshots + to back up data on a regular interval. For more information, read Creating + persistent disk snapshots. + properties: + autoCreated: + description: '[Output Only] Set to true if snapshots are automatically created + by applying resource policy on the target disk.' + type: boolean + chainName: + description: Creates the new snapshot in the snapshot chain labeled with + the specified name. The chain name must be 1-63 characters long and comply + with RFC1035. This is an uncommon option only for advanced service owners + who needs to create separate snapshot chains, for example, for chargeback + tracking. When you describe your snapshot resource, this field is visible + only if it has a non-empty value. + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + diskSizeGb: + description: '[Output Only] Size of the source disk, specified in GB.' + format: int64 + type: string + downloadBytes: + description: '[Output Only] Number of bytes downloaded to restore a snapshot + to a disk.' + format: int64 + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#snapshot + description: '[Output Only] Type of the resource. Always compute#snapshot + for Snapshot resources.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this snapshot, + which is essentially a hash of the labels set used for optimistic locking. + The fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve a snapshot. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels to apply to this snapshot. These can be later modified + by the setLabels method. Label values may be empty. + type: object + licenseCodes: + description: '[Output Only] Integer license codes indicating which licenses + are attached to this snapshot.' + items: + format: int64 + type: string + type: array + licenses: + description: '[Output Only] A list of public visible licenses that apply + to this snapshot. This can be because the original image had licenses + attached (such as a Windows image).' + items: + type: string + type: array + locationHint: + description: An opaque location hint used to place the snapshot close to + other resources. This field is for use by internal tools that use the + public API. + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + snapshotEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: Encrypts the snapshot using a customer-supplied encryption + key. After you encrypt a snapshot using a customer-supplied key, you must + provide the same key if you use the snapshot later. For example, you must + provide the encryption key when you create a disk from the encrypted snapshot + in a future request. Customer-supplied encryption keys do not protect + access to metadata of the snapshot. If you do not provide an encryption + key when creating the snapshot, then the snapshot will be encrypted using + an automatically generated key and you do not need to provide a key to + use the snapshot later. + sourceDisk: + description: The source disk used to create this snapshot. + type: string + sourceDiskEncryptionKey: + $ref: '#/components/schemas/CustomerEncryptionKey' + description: The customer-supplied encryption key of the source disk. Required + if the source disk is protected by a customer-supplied encryption key. + sourceDiskId: + description: '[Output Only] The ID value of the disk used to create this + snapshot. This value may be used to determine whether the snapshot was + taken from the current or a previous instance of a given disk name.' + type: string + status: + description: '[Output Only] The status of the snapshot. This can be CREATING, + DELETING, FAILED, READY, or UPLOADING.' + enum: + - CREATING + - DELETING + - FAILED + - READY + - UPLOADING + type: string + storageBytes: + description: '[Output Only] A size of the storage used by the snapshot. + As snapshots share storage, this number is expected to change with snapshot + creation/deletion.' + format: int64 + type: string + storageBytesStatus: + description: '[Output Only] An indicator whether storageBytes is in a stable + state or it is being adjusted as a result of shared storage reallocation. + This status can either be UPDATING, meaning the size of the snapshot is + being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.' + enum: + - UPDATING + - UP_TO_DATE + type: string + storageLocations: + description: Cloud Storage bucket storage location of the snapshot (regional + or multi-regional). + items: + type: string + type: array + type: object + SnapshotList: + description: Contains a list of Snapshot resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Snapshot resources. + items: + $ref: '#/components/schemas/Snapshot' + type: array + kind: + default: compute#snapshotList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SourceInstanceParams: + description: A specification of the parameters to use when creating the instance + template from a source instance. + properties: + diskConfigs: + description: 'Attached disks configuration. If not provided, defaults are + applied: For boot disk and any other R/W disks, new custom images will + be created from each disk. For read-only disks, they will be attached + in read-only mode. Local SSD disks will be created as blank volumes.' + items: + $ref: '#/components/schemas/DiskInstantiationConfig' + type: array + type: object + SslCertificate: + description: 'Represents an SSL Certificate resource. Google Compute Engine + has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) + * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The sslCertificates + are used by: - external HTTPS load balancers - SSL proxy load balancers The + regionSslCertificates are used by internal HTTPS load balancers. Optionally, + certificate file contents that you upload can contain a set of up to five + PEM-encoded certificates. The API call creates an object (sslCertificate) + that holds this data. You can use SSL keys and certificates to secure connections + to a load balancer. For more information, read Creating and using SSL certificates, + SSL certificates quotas and limits, and Troubleshooting SSL certificates.' + properties: + certificate: + description: A value read into memory from a certificate file. The certificate + file must be in PEM format. The certificate chain must be no greater than + 5 certs long. The chain must include at least one intermediate cert. + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + expireTime: + description: '[Output Only] Expire time of the certificate. RFC3339' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#sslCertificate + description: '[Output Only] Type of the resource. Always compute#sslCertificate + for SSL certificates.' + type: string + managed: + $ref: '#/components/schemas/SslCertificateManagedSslCertificate' + description: Configuration and status of a managed SSL certificate. + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + privateKey: + description: A value read into memory from a write-only private key file. + The private key file must be in PEM format. For security, only insert + requests include this field. + type: string + region: + description: '[Output Only] URL of the region where the regional SSL Certificate + resides. This field is not applicable to global SSL Certificate.' + type: string + selfLink: + description: '[Output only] Server-defined URL for the resource.' + type: string + selfManaged: + $ref: '#/components/schemas/SslCertificateSelfManagedSslCertificate' + description: Configuration and status of a self-managed SSL certificate. + subjectAlternativeNames: + description: '[Output Only] Domains associated with the certificate via + Subject Alternative Name.' + items: + type: string + type: array + type: + description: (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" + or "MANAGED". If not specified, the certificate is self-managed and the + fields certificate and private_key are used. + enum: + - MANAGED + - SELF_MANAGED + - TYPE_UNSPECIFIED + type: string + type: object + SslCertificateAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/SslCertificatesScopedList' + description: Name of the scope containing this set of SslCertificates. + description: A list of SslCertificatesScopedList resources. + type: object + kind: + default: compute#sslCertificateAggregatedList + description: '[Output Only] Type of resource. Always compute#sslCertificateAggregatedList + for lists of SSL Certificates.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SslCertificateList: + description: Contains a list of SslCertificate resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of SslCertificate resources. + items: + $ref: '#/components/schemas/SslCertificate' + type: array + kind: + default: compute#sslCertificateList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SslCertificateManagedSslCertificate: + description: Configuration and status of a managed SSL certificate. + properties: + domainStatus: + additionalProperties: + enum: + - ACTIVE + - DOMAIN_STATUS_UNSPECIFIED + - FAILED_CAA_CHECKING + - FAILED_CAA_FORBIDDEN + - FAILED_NOT_VISIBLE + - FAILED_RATE_LIMITED + - PROVISIONING + type: string + description: '[Output only] Detailed statuses of the domains specified for + managed certificate resource.' + type: object + domains: + description: The domains for which a managed SSL certificate will be generated. + Each Google-managed SSL certificate supports up to the [maximum number + of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates). + items: + type: string + type: array + status: + description: '[Output only] Status of the managed certificate resource.' + enum: + - ACTIVE + - MANAGED_CERTIFICATE_STATUS_UNSPECIFIED + - PROVISIONING + - PROVISIONING_FAILED + - PROVISIONING_FAILED_PERMANENTLY + - RENEWAL_FAILED + type: string + type: object + SslCertificateSelfManagedSslCertificate: + description: Configuration and status of a self-managed SSL certificate. + properties: + certificate: + description: A local certificate file. The certificate must be in PEM format. + The certificate chain must be no greater than 5 certs long. The chain + must include at least one intermediate cert. + type: string + privateKey: + description: A write-only private key in PEM format. Only insert requests + will include this field. + type: string + type: object + SslCertificatesScopedList: + properties: + sslCertificates: + description: List of SslCertificates contained in this scope. + items: + $ref: '#/components/schemas/SslCertificate' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SslPoliciesList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of SslPolicy resources. + items: + $ref: '#/components/schemas/SslPolicy' + type: array + kind: + default: compute#sslPoliciesList + description: '[Output Only] Type of the resource. Always compute#sslPoliciesList + for lists of sslPolicies.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SslPoliciesListAvailableFeaturesResponse: + properties: + features: + items: + type: string + type: array + type: object + SslPolicy: + description: Represents an SSL Policy resource. Use SSL policies to control + the SSL features, such as versions and cipher suites, offered by an HTTPS + or SSL Proxy load balancer. For more information, read SSL Policy Concepts. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + customFeatures: + description: A list of features enabled when the selected profile is CUSTOM. + The method returns the set of features that can be specified in this list. + This field must be empty if the profile is not CUSTOM. + items: + type: string + type: array + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + enabledFeatures: + description: '[Output Only] The list of features enabled in the SSL policy.' + items: + type: string + type: array + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a SslPolicy. An up-to-date fingerprint must + be provided in order to update the SslPolicy, otherwise the request will + fail with error 412 conditionNotMet. To see the latest fingerprint, make + a get() request to retrieve an SslPolicy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#sslPolicy + description: '[Output only] Type of the resource. Always compute#sslPolicyfor + SSL policies.' + type: string + minTlsVersion: + description: The minimum version of SSL protocol that can be used by the + clients to establish a connection with the load balancer. This can be + one of TLS_1_0, TLS_1_1, TLS_1_2. + enum: + - TLS_1_0 + - TLS_1_1 + - TLS_1_2 + type: string + name: + description: Name of the resource. 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 + profile: + description: Profile specifies the set of SSL features that can be used + by the load balancer when negotiating SSL with clients. This can be one + of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set + of SSL features to enable must be specified in the customFeatures field. + enum: + - COMPATIBLE + - CUSTOM + - MODERN + - RESTRICTED + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + warnings: + description: '[Output Only] If potential misconfigurations are detected + for this SSL policy, this field will be populated with warning messages.' + items: + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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: array + type: object + SslPolicyReference: + properties: + sslPolicy: + description: URL of the SSL policy resource. Set this to empty string to + clear any existing SSL policy associated with the target proxy resource. + type: string + type: object + StatefulPolicy: + properties: + preservedState: + $ref: '#/components/schemas/StatefulPolicyPreservedState' + type: object + StatefulPolicyPreservedState: + description: Configuration of preserved resources. + properties: + disks: + additionalProperties: + $ref: '#/components/schemas/StatefulPolicyPreservedStateDiskDevice' + description: Disks created on the instances that will be preserved on instance + delete, update, etc. This map is keyed with the device names of the disks. + type: object + type: object + StatefulPolicyPreservedStateDiskDevice: + properties: + autoDelete: + description: 'These stateful disks will never be deleted during autohealing, + update or VM instance recreate operations. This flag is used to configure + if the disk should be deleted after it is no longer used by the group, + e.g. when the given instance or the whole group is deleted. Note: disks + attached in READ_ONLY mode cannot be auto-deleted.' + enum: + - NEVER + - ON_PERMANENT_INSTANCE_DELETION + type: string + type: object + Subnetwork: + description: Represents a Subnetwork resource. A subnetwork (also known as a + subnet) is a logical partition of a Virtual Private Cloud network with one + primary IP range and zero or more secondary IP ranges. For more information, + read Virtual Private Cloud (VPC) Network. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. This field can be set only at resource creation + time. + type: string + enableFlowLogs: + description: Whether to enable flow logging for this subnetwork. If this + field is not explicitly set, it will not appear in get listings. If not + set the default behavior is to disable flow logging. This field isn't + supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER. + type: boolean + externalIpv6Prefix: + description: '[Output Only] The range of external IPv6 addresses that are + owned by this subnetwork.' + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a Subnetwork. An up-to-date fingerprint must + be provided in order to update the Subnetwork, otherwise the request will + fail with error 412 conditionNotMet. To see the latest fingerprint, make + a get() request to retrieve a Subnetwork. + format: byte + type: string + gatewayAddress: + description: '[Output Only] The gateway address for default routes to reach + destination addresses outside this subnetwork.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + ipCidrRange: + description: The range of internal addresses that are owned by this subnetwork. + Provide this property when you create the subnetwork. For example, 10.0.0.0/8 + or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. + Only IPv4 is supported. This field is set at resource creation time. The + range can be any range listed in the Valid ranges list. The range can + be expanded after creation using expandIpCidrRange. + type: string + ipv6AccessType: + description: The access type of IPv6 address this subnet holds. It's immutable + and can only be specified during creation or the first time the subnet + is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then + this subnet cannot enable direct path. + enum: + - EXTERNAL + - UNSPECIFIED_IPV6_ACCESS_TYPE + type: string + ipv6CidrRange: + description: '[Output Only] The range of internal IPv6 addresses that are + owned by this subnetwork.' + type: string + kind: + default: compute#subnetwork + description: '[Output Only] Type of the resource. Always compute#subnetwork + for Subnetwork resources.' + type: string + logConfig: + $ref: '#/components/schemas/SubnetworkLogConfig' + description: This field denotes the VPC flow logging options for this subnetwork. + If logging is enabled, logs are exported to Cloud Logging. + name: + description: The name of the resource, provided by the client when initially + creating the resource. 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 + network: + description: The URL of the network to which this subnetwork belongs, provided + by the client when initially creating the subnetwork. This field can be + set only at resource creation time. + type: string + privateIpGoogleAccess: + description: Whether the VMs in this subnet can access Google services without + assigned external IP addresses. This field can be both set at resource + creation time and updated using setPrivateIpGoogleAccess. + type: boolean + privateIpv6GoogleAccess: + description: The private IPv6 google access type for the VMs in this subnet. + This is an expanded field of enablePrivateV6Access. If both fields are + set, privateIpv6GoogleAccess will take priority. This field can be both + set at resource creation time and updated using patch. + enum: + - DISABLE_GOOGLE_ACCESS + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + type: string + purpose: + description: The purpose of the resource. This field can be either PRIVATE_RFC_1918 + or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER + is a user-created subnetwork that is reserved for Internal HTTP(S) Load + Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The + enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER. + enum: + - INTERNAL_HTTPS_LOAD_BALANCER + - PRIVATE + - PRIVATE_RFC_1918 + - PRIVATE_SERVICE_CONNECT + type: string + region: + description: URL of the region where the Subnetwork resides. This field + can be set only at resource creation time. + type: string + role: + description: The role of subnetwork. Currently, this field is only used + when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE + or BACKUP. An ACTIVE subnetwork is one that is currently being used for + Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready + to be promoted to ACTIVE or is currently draining. This field can be updated + with a patch request. + enum: + - ACTIVE + - BACKUP + type: string + secondaryIpRanges: + description: An array of configurations for secondary IP ranges for VM instances + contained in this subnetwork. The primary IP of such VM must belong to + the primary ipCidrRange of the subnetwork. The alias IPs may belong to + either primary or secondary ranges. This field can be updated with a patch + request. + items: + $ref: '#/components/schemas/SubnetworkSecondaryRange' + type: array + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + stackType: + description: The stack type for this subnet to identify whether the IPv6 + feature is enabled or not. If not specified IPV4_ONLY will be used. This + field can be both set at resource creation time and updated using patch. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - UNSPECIFIED_STACK_TYPE + type: string + state: + description: '[Output Only] The state of the subnetwork, which can be one + of the following values: READY: Subnetwork is created and ready to use + DRAINING: only applicable to subnetworks that have the purpose set to + INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load + balancer are being drained. A subnetwork that is draining cannot be used + or modified until it reaches a status of READY' + enum: + - DRAINING + - READY + type: string + type: object + SubnetworkAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/SubnetworksScopedList' + description: Name of the scope containing this set of Subnetworks. + description: A list of SubnetworksScopedList resources. + type: object + kind: + default: compute#subnetworkAggregatedList + description: '[Output Only] Type of resource. Always compute#subnetworkAggregatedList + for aggregated lists of subnetworks.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SubnetworkList: + description: Contains a list of Subnetwork resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Subnetwork resources. + items: + $ref: '#/components/schemas/Subnetwork' + type: array + kind: + default: compute#subnetworkList + description: '[Output Only] Type of resource. Always compute#subnetworkList + for lists of subnetworks.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SubnetworkLogConfig: + description: The available logging options for this subnetwork. + properties: + aggregationInterval: + description: Can only be specified if VPC flow logging for this subnetwork + is enabled. Toggles the aggregation interval for collecting flow logs. + Increasing the interval time will reduce the amount of generated flow + logs for long lasting connections. Default is an interval of 5 seconds + per connection. + enum: + - INTERVAL_10_MIN + - INTERVAL_15_MIN + - INTERVAL_1_MIN + - INTERVAL_30_SEC + - INTERVAL_5_MIN + - INTERVAL_5_SEC + type: string + enable: + description: Whether to enable flow logging for this subnetwork. If this + field is not explicitly set, it will not appear in get listings. If not + set the default behavior is to disable flow logging. + type: boolean + filterExpr: + description: Can only be specified if VPC flow logs for this subnetwork + is enabled. Export filter used to define which VPC flow logs should be + logged. + type: string + flowSampling: + description: Can only be specified if VPC flow logging for this subnetwork + is enabled. The value of the field must be in [0, 1]. Set the sampling + rate of VPC flow logs within the subnetwork where 1.0 means all collected + logs are reported and 0.0 means no logs are reported. Default is 0.5, + which means half of all collected logs are reported. + format: float + type: number + metadata: + description: Can only be specified if VPC flow logs for this subnetwork + is enabled. Configures whether all, none or a subset of metadata fields + should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA. + enum: + - CUSTOM_METADATA + - EXCLUDE_ALL_METADATA + - INCLUDE_ALL_METADATA + type: string + metadataFields: + description: Can only be specified if VPC flow logs for this subnetwork + is enabled and "metadata" was set to CUSTOM_METADATA. + items: + type: string + type: array + type: object + SubnetworkSecondaryRange: + description: Represents a secondary IP range of a subnetwork. + properties: + ipCidrRange: + description: The range of IP addresses belonging to this subnetwork secondary + range. Provide this property when you create the subnetwork. Ranges must + be unique and non-overlapping with all primary and secondary IP ranges + within a network. Only IPv4 is supported. The range can be any range listed + in the Valid ranges list. + type: string + rangeName: + description: The name associated with this subnetwork secondary range, used + when adding an alias IP range to a VM instance. The name must be 1-63 + characters long, and comply with RFC1035. The name must be unique within + the subnetwork. + type: string + type: object + SubnetworksExpandIpCidrRangeRequest: + properties: + ipCidrRange: + description: The IP (in CIDR format or netmask) of internal addresses that + are legal on this Subnetwork. This range should be disjoint from other + subnetworks within this network. This range can only be larger than (i.e. + a superset of) the range previously defined before the update. + type: string + type: object + SubnetworksScopedList: + properties: + subnetworks: + description: A list of subnetworks contained in this scope. + items: + $ref: '#/components/schemas/Subnetwork' + type: array + warning: + description: An informational warning that appears when the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + SubnetworksSetPrivateIpGoogleAccessRequest: + properties: + privateIpGoogleAccess: + type: boolean + type: object + Subsetting: + description: Subsetting configuration for this BackendService. Currently this + is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load + balancing and Traffic Director. + properties: + policy: + enum: + - CONSISTENT_HASH_SUBSETTING + - NONE + type: string + type: object + TCPHealthCheck: + properties: + port: + description: The TCP port number for the health check request. The default + value is 80. Valid values are 1 through 65535. + format: int32 + type: integer + portName: + description: Port name as defined in InstanceGroup#NamedPort#name. If both + port and port_name are defined, port takes precedence. + type: string + portSpecification: + description: 'Specifies how port is selected for health checking, can be + one of following values: USE_FIXED_PORT: The port number in port is used + for health checking. USE_NAMED_PORT: The portName is used for health checking. + USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + network endpoint is used for health checking. For other backends, the + port or named port specified in the Backend Service is used for health + checking. If not specified, TCP health check follows behavior specified + in port and portName fields.' + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + request: + description: The application data to send once the TCP connection has been + established (default value is empty). If both request and response are + empty, the connection establishment alone will indicate health. The request + data can only be ASCII. + type: string + response: + description: The bytes to match against the beginning of the response data. + If left empty (the default value), any response will indicate health. + The response data can only be ASCII. + type: string + type: object + Tags: + description: A set of instance tags. + properties: + fingerprint: + description: Specifies a fingerprint for this request, which is essentially + a hash of the tags' contents and used for optimistic locking. The fingerprint + is initially generated by Compute Engine and changes after every request + to modify or update tags. You must always provide an up-to-date fingerprint + hash in order to update or change tags. To see the latest fingerprint, + make get() request to the instance. + format: byte + type: string + items: + description: An array of tags. Each tag must be 1-63 characters long, and + comply with RFC1035. + items: + type: string + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: array + type: object + TargetGrpcProxy: + description: Represents a Target gRPC Proxy resource. A target gRPC proxy is + a component of load balancers intended for load balancing gRPC traffic. Only + global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can + reference a target gRPC proxy. The target gRPC Proxy references a URL map + that specifies how traffic is routed to gRPC backend services. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a TargetGrpcProxy. An up-to-date fingerprint + must be provided in order to patch/update the TargetGrpcProxy; otherwise, + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the TargetGrpcProxy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource type. + The server generates this identifier.' + format: uint64 + type: string + kind: + default: compute#targetGrpcProxy + description: '[Output Only] Type of the resource. Always compute#targetGrpcProxy + for target grpc proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + selfLinkWithId: + description: '[Output Only] Server-defined URL with id for the resource.' + type: string + urlMap: + description: URL to the UrlMap resource that defines the mapping from URL + to the BackendService. The protocol field in the BackendService must be + set to GRPC. + type: string + validateForProxyless: + description: If true, indicates that the BackendServices referenced by the + urlMap may be accessed by gRPC applications without using a sidecar proxy. + This will enable configuration checks on urlMap and its referenced BackendServices + to not allow unsupported features. A gRPC application must use "xds:///" + scheme in the target URI of the service it is connecting to. If false, + indicates that the BackendServices referenced by the urlMap will be accessed + by gRPC applications via a sidecar proxy. In this case, a gRPC application + must not use "xds:///" scheme in the target URI of the service it is connecting + to + type: boolean + type: object + TargetGrpcProxyList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetGrpcProxy resources. + items: + $ref: '#/components/schemas/TargetGrpcProxy' + type: array + kind: + default: compute#targetGrpcProxyList + description: '[Output Only] Type of the resource. Always compute#targetGrpcProxy + for target grpc proxies.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpProxiesScopedList: + properties: + targetHttpProxies: + description: A list of TargetHttpProxies contained in this scope. + items: + $ref: '#/components/schemas/TargetHttpProxy' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpProxy: + description: 'Represents a Target HTTP Proxy resource. Google Compute Engine + has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) + * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target + HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies + are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies + are used by internal HTTP load balancers. Forwarding rules reference a target + HTTP proxy, and the target proxy then references a URL map. For more information, + read Using Target Proxies and Forwarding rule concepts.' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint + must be provided in order to patch/update the TargetHttpProxy; otherwise, + the request will fail with error 412 conditionNotMet. To see the latest + fingerprint, make a get() request to retrieve the TargetHttpProxy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetHttpProxy + description: '[Output Only] Type of resource. Always compute#targetHttpProxy + for target HTTP proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + proxyBind: + description: This field only applies when the forwarding rule that references + this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. + When this field is set to true, Envoy proxies set up inbound traffic interception + and bind to the IP address and port specified in the forwarding rule. + This is generally useful when using Traffic Director to configure Envoy + as a gateway or middle proxy (in other words, not a sidecar proxy). The + Envoy proxy listens for inbound requests and handles requests when it + receives them. The default is false. + type: boolean + region: + description: '[Output Only] URL of the region where the regional Target + HTTP Proxy resides. This field is not applicable to global Target HTTP + Proxies.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + urlMap: + description: URL to the UrlMap resource that defines the mapping from URL + to the BackendService. + type: string + type: object + TargetHttpProxyAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetHttpProxiesScopedList' + description: Name of the scope containing this set of TargetHttpProxies. + description: A list of TargetHttpProxiesScopedList resources. + type: object + kind: + default: compute#targetHttpProxyAggregatedList + description: '[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList + for lists of Target HTTP Proxies.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + type: object + TargetHttpProxyList: + description: A list of TargetHttpProxy resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetHttpProxy resources. + items: + $ref: '#/components/schemas/TargetHttpProxy' + type: array + kind: + default: compute#targetHttpProxyList + description: Type of resource. Always compute#targetHttpProxyList for lists + of target HTTP proxies. + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpsProxiesScopedList: + properties: + targetHttpsProxies: + description: A list of TargetHttpsProxies contained in this scope. + items: + $ref: '#/components/schemas/TargetHttpsProxy' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpsProxiesSetQuicOverrideRequest: + properties: + quicOverride: + description: QUIC policy for the TargetHttpsProxy resource. + enum: + - DISABLE + - ENABLE + - NONE + type: string + type: object + TargetHttpsProxiesSetSslCertificatesRequest: + properties: + sslCertificates: + description: New set of SslCertificate resources to associate with this + TargetHttpsProxy resource. At least one SSL certificate must be specified. + Currently, you may specify up to 15 SSL certificates. + items: + type: string + type: array + type: object + TargetHttpsProxy: + description: 'Represents a Target HTTPS Proxy resource. Google Compute Engine + has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpsProxies) + * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpsProxies) A target + HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies + are used by external HTTPS load balancers. * regionTargetHttpsProxies are + used by internal HTTPS load balancers. Forwarding rules reference a target + HTTPS proxy, and the target proxy then references a URL map. For more information, + read Using Target Proxies and Forwarding rule concepts.' + properties: + authorizationPolicy: + description: 'Optional. A URL referring to a networksecurity.AuthorizationPolicy + resource that describes how the proxy should authorize inbound traffic. + If left blank, access will not be restricted by an authorization policy. + Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy + only applies to a global TargetHttpsProxy attached to globalForwardingRules + with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This + field currently has no impact.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint + must be provided in order to patch the TargetHttpsProxy; otherwise, the + request will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve the TargetHttpsProxy. + format: byte + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetHttpsProxy + description: '[Output Only] Type of resource. Always compute#targetHttpsProxy + for target HTTPS proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + proxyBind: + description: This field only applies when the forwarding rule that references + this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. + When this field is set to true, Envoy proxies set up inbound traffic interception + and bind to the IP address and port specified in the forwarding rule. + This is generally useful when using Traffic Director to configure Envoy + as a gateway or middle proxy (in other words, not a sidecar proxy). The + Envoy proxy listens for inbound requests and handles requests when it + receives them. The default is false. + type: boolean + quicOverride: + description: 'Specifies the QUIC override policy for this TargetHttpsProxy + resource. This setting determines whether the load balancer attempts to + negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. + - When quic-override is set to NONE, Google manages whether QUIC is used. + - When quic-override is set to ENABLE, the load balancer uses QUIC when + possible. - When quic-override is set to DISABLE, the load balancer doesn''t + use QUIC. - If the quic-override flag is not specified, NONE is implied. ' + enum: + - DISABLE + - ENABLE + - NONE + type: string + region: + description: '[Output Only] URL of the region where the regional TargetHttpsProxy + resides. This field is not applicable to global TargetHttpsProxies.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + serverTlsPolicy: + description: 'Optional. A URL referring to a networksecurity.ServerTlsPolicy + resource that describes how the proxy should authenticate inbound traffic. + serverTlsPolicy only applies to a global TargetHttpsProxy attached to + globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. + If left blank, communications are not encrypted. Note: This field currently + has no impact.' + type: string + sslCertificates: + description: URLs to SslCertificate resources that are used to authenticate + connections between users and the load balancer. At least one SSL certificate + must be specified. Currently, you may specify up to 15 SSL certificates. + sslCertificates do not apply when the load balancing scheme is set to + INTERNAL_SELF_MANAGED. + items: + type: string + type: array + sslPolicy: + description: URL of SslPolicy resource that will be associated with the + TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has + no SSL policy configured. + type: string + urlMap: + description: 'A fully-qualified or valid partial URL to the UrlMap resource + that defines the mapping from URL to the BackendService. For example, + the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ + url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map ' + type: string + type: object + TargetHttpsProxyAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetHttpsProxiesScopedList' + description: Name of the scope containing this set of TargetHttpsProxies. + description: A list of TargetHttpsProxiesScopedList resources. + type: object + kind: + default: compute#targetHttpsProxyAggregatedList + description: '[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList + for lists of Target HTTP Proxies.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetHttpsProxyList: + description: Contains a list of TargetHttpsProxy resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetHttpsProxy resources. + items: + $ref: '#/components/schemas/TargetHttpsProxy' + type: array + kind: + default: compute#targetHttpsProxyList + description: Type of resource. Always compute#targetHttpsProxyList for lists + of target HTTPS proxies. + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetInstance: + description: Represents a Target Instance resource. You can use a target instance + to handle traffic for one or more forwarding rules, which is ideal for forwarding + protocol traffic that is managed by a single source. For example, ESP, AH, + TCP, or UDP. For more information, read Target instances. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + instance: + description: 'A URL to the virtual machine instance that handles traffic + for this target instance. When creating a target instance, you can provide + the fully-qualified URL or a valid partial URL to the desired virtual + machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone + /instances/instance - projects/project/zones/zone/instances/instance - + zones/zone/instances/instance ' + type: string + kind: + default: compute#targetInstance + description: '[Output Only] The type of the resource. Always compute#targetInstance + for target instances.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + natPolicy: + description: NAT option controlling how IPs are NAT'ed to the instance. + Currently only NO_NAT (default value) is supported. + enum: + - NO_NAT + type: string + network: + description: The URL of the network this target instance uses to forward + traffic. If not specified, the traffic will be forwarded to the network + that the default network interface belongs to. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + zone: + description: '[Output Only] URL of the zone where the target instance resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + type: object + TargetInstanceAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetInstancesScopedList' + description: Name of the scope containing this set of target instances. + description: A list of TargetInstance resources. + type: object + kind: + default: compute#targetInstanceAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetInstanceList: + description: Contains a list of TargetInstance resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetInstance resources. + items: + $ref: '#/components/schemas/TargetInstance' + type: array + kind: + default: compute#targetInstanceList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetInstancesScopedList: + properties: + targetInstances: + description: A list of target instances contained in this scope. + items: + $ref: '#/components/schemas/TargetInstance' + type: array + warning: + description: Informational warning which replaces the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetPool: + description: Represents a Target Pool resource. Target pools are used for network + TCP/UDP load balancing. A target pool references member instances, an associated + legacy HttpHealthCheck resource, and, optionally, a backup target pool. For + more information, read Using target pools. + properties: + backupPool: + description: 'The server-defined URL for the resource. This field is applicable + only when the containing target pool is serving a forwarding rule as the + primary pool, and its failoverRatio field is properly set to a value between + [0, 1]. backupPool and failoverRatio together define the fallback behavior + of the primary target pool: if the ratio of the healthy instances in the + primary pool is at or below failoverRatio, traffic arriving at the load-balanced + IP will be directed to the backup pool. In case where failoverRatio and + backupPool are not set, or all the instances in the backup pool are unhealthy, + the traffic will be directed back to the primary pool in the "force" mode, + where traffic will be spread to the healthy instances with the best effort, + or to all instances when no instance is healthy.' + type: string + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + failoverRatio: + description: 'This field is applicable only when the containing target pool + is serving a forwarding rule as the primary pool (i.e., not as a backup + pool to some other target pool). The value of the field must be in [0, + 1]. If set, backupPool must also be set. They together define the fallback + behavior of the primary target pool: if the ratio of the healthy instances + in the primary pool is at or below this number, traffic arriving at the + load-balanced IP will be directed to the backup pool. In case where failoverRatio + is not set or all the instances in the backup pool are unhealthy, the + traffic will be directed back to the primary pool in the "force" mode, + where traffic will be spread to the healthy instances with the best effort, + or to all instances when no instance is healthy.' + format: float + type: number + healthChecks: + description: The URL of the HttpHealthCheck resource. A member instance + in this pool is considered healthy if and only if the health checks pass. + Only legacy HttpHealthChecks are supported. Only one health check may + be specified. + items: + type: string + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + instances: + description: A list of resource URLs to the virtual machine instances serving + this pool. They must live in zones contained in the same region as this + pool. + items: + type: string + type: array + kind: + default: compute#targetPool + description: '[Output Only] Type of the resource. Always compute#targetPool + for target pools.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + region: + description: '[Output Only] URL of the region where the target pool resides.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sessionAffinity: + description: 'Session affinity option, must be one of the following values: + NONE: Connections from the same client IP may go to any instance in the + pool. CLIENT_IP: Connections from the same client IP will go to the same + instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: + Connections from the same client IP with the same IP protocol will go + to the same instance in the pool while that instance remains healthy.' + enum: + - CLIENT_IP + - CLIENT_IP_NO_DESTINATION + - CLIENT_IP_PORT_PROTO + - CLIENT_IP_PROTO + - GENERATED_COOKIE + - HEADER_FIELD + - HTTP_COOKIE + - NONE + type: string + type: object + TargetPoolAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetPoolsScopedList' + description: Name of the scope containing this set of target pools. + description: A list of TargetPool resources. + type: object + kind: + default: compute#targetPoolAggregatedList + description: '[Output Only] Type of resource. Always compute#targetPoolAggregatedList + for aggregated lists of target pools.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetPoolInstanceHealth: + properties: + healthStatus: + items: + $ref: '#/components/schemas/HealthStatus' + type: array + kind: + default: compute#targetPoolInstanceHealth + description: '[Output Only] Type of resource. Always compute#targetPoolInstanceHealth + when checking the health of an instance.' + type: string + type: object + TargetPoolList: + description: Contains a list of TargetPool resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetPool resources. + items: + $ref: '#/components/schemas/TargetPool' + type: array + kind: + default: compute#targetPoolList + description: '[Output Only] Type of resource. Always compute#targetPoolList + for lists of target pools.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetPoolsAddHealthCheckRequest: + properties: + healthChecks: + description: The HttpHealthCheck to add to the target pool. + items: + $ref: '#/components/schemas/HealthCheckReference' + type: array + type: object + TargetPoolsAddInstanceRequest: + properties: + instances: + description: 'A full or partial URL to an instance to add to this target + pool. This can be a full or partial URL. For example, the following are + valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone + /instances/instance-name - projects/project-id/zones/zone/instances/instance-name + - zones/zone/instances/instance-name ' + items: + $ref: '#/components/schemas/InstanceReference' + type: array + type: object + TargetPoolsRemoveHealthCheckRequest: + properties: + healthChecks: + description: 'Health check URL to be removed. This can be a full or valid + partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project + /global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check + - global/httpHealthChecks/health-check ' + items: + $ref: '#/components/schemas/HealthCheckReference' + type: array + type: object + TargetPoolsRemoveInstanceRequest: + properties: + instances: + description: URLs of the instances to be removed from target pool. + items: + $ref: '#/components/schemas/InstanceReference' + type: array + type: object + TargetPoolsScopedList: + properties: + targetPools: + description: A list of target pools contained in this scope. + items: + $ref: '#/components/schemas/TargetPool' + type: array + warning: + description: Informational warning which replaces the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetReference: + properties: + target: + type: string + type: object + TargetSslProxiesSetBackendServiceRequest: + properties: + service: + description: The URL of the new BackendService resource for the targetSslProxy. + type: string + type: object + TargetSslProxiesSetProxyHeaderRequest: + properties: + proxyHeader: + description: The new type of proxy header to append before sending data + to the backend. NONE or PROXY_V1 are allowed. + enum: + - NONE + - PROXY_V1 + type: string + type: object + TargetSslProxiesSetSslCertificatesRequest: + properties: + sslCertificates: + description: New set of URLs to SslCertificate resources to associate with + this TargetSslProxy. At least one SSL certificate must be specified. Currently, + you may specify up to 15 SSL certificates. + items: + type: string + type: array + type: object + TargetSslProxy: + description: Represents a Target SSL Proxy resource. A target SSL proxy is a + component of a SSL Proxy load balancer. Global forwarding rules reference + a target SSL proxy, and the target proxy then references an external backend + service. For more information, read Using Target Proxies. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetSslProxy + description: '[Output Only] Type of the resource. Always compute#targetSslProxy + for target SSL proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + service: + description: URL to the BackendService resource. + type: string + sslCertificates: + description: URLs to SslCertificate resources that are used to authenticate + connections to Backends. At least one SSL certificate must be specified. + Currently, you may specify up to 15 SSL certificates. sslCertificates + do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + items: + type: string + type: array + sslPolicy: + description: URL of SslPolicy resource that will be associated with the + TargetSslProxy resource. If not set, the TargetSslProxy resource will + not have any SSL policy configured. + type: string + type: object + TargetSslProxyList: + description: Contains a list of TargetSslProxy resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetSslProxy resources. + items: + $ref: '#/components/schemas/TargetSslProxy' + type: array + kind: + default: compute#targetSslProxyList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetTcpProxiesSetBackendServiceRequest: + properties: + service: + description: The URL of the new BackendService resource for the targetTcpProxy. + type: string + type: object + TargetTcpProxiesSetProxyHeaderRequest: + properties: + proxyHeader: + description: The new type of proxy header to append before sending data + to the backend. NONE or PROXY_V1 are allowed. + enum: + - NONE + - PROXY_V1 + type: string + type: object + TargetTcpProxy: + description: Represents a Target TCP Proxy resource. A target TCP proxy is a + component of a TCP Proxy load balancer. Global forwarding rules reference + target TCP proxy, and the target proxy then references an external backend + service. For more information, read TCP Proxy Load Balancing overview. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetTcpProxy + description: '[Output Only] Type of the resource. Always compute#targetTcpProxy + for target TCP proxies.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + proxyBind: + description: This field only applies when the forwarding rule that references + this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. + When this field is set to true, Envoy proxies set up inbound traffic interception + and bind to the IP address and port specified in the forwarding rule. + This is generally useful when using Traffic Director to configure Envoy + as a gateway or middle proxy (in other words, not a sidecar proxy). The + Envoy proxy listens for inbound requests and handles requests when it + receives them. The default is false. + type: boolean + proxyHeader: + description: Specifies the type of proxy header to append before sending + data to the backend, either NONE or PROXY_V1. The default is NONE. + enum: + - NONE + - PROXY_V1 + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + service: + description: URL to the BackendService resource. + type: string + type: object + TargetTcpProxyList: + description: Contains a list of TargetTcpProxy resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetTcpProxy resources. + items: + $ref: '#/components/schemas/TargetTcpProxy' + type: array + kind: + default: compute#targetTcpProxyList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetVpnGateway: + description: Represents a Target VPN Gateway resource. The target VPN gateway + resource represents a Classic Cloud VPN gateway. For more information, read + the the Cloud VPN Overview. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + forwardingRules: + description: '[Output Only] A list of URLs to the ForwardingRule resources. + ForwardingRules are created using compute.forwardingRules.insert and associated + with a VPN gateway.' + items: + type: string + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#targetVpnGateway + description: '[Output Only] Type of resource. Always compute#targetVpnGateway + for target VPN gateways.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: URL of the network to which this VPN gateway is attached. Provided + by the client when the VPN gateway is created. + type: string + region: + description: '[Output Only] URL of the region where the target VPN gateway + resides. You must specify this field as part of the HTTP request URL. + It is not settable as a field in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] The status of the VPN gateway, which can be + one of the following: CREATING, READY, FAILED, or DELETING.' + enum: + - CREATING + - DELETING + - FAILED + - READY + type: string + tunnels: + description: '[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels + are created using the compute.vpntunnels.insert method and associated + with a VPN gateway.' + items: + type: string + type: array + type: object + TargetVpnGatewayAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/TargetVpnGatewaysScopedList' + description: '[Output Only] Name of the scope containing this set of target + VPN gateways.' + description: A list of TargetVpnGateway resources. + type: object + kind: + default: compute#targetVpnGatewayAggregatedList + description: '[Output Only] Type of resource. Always compute#targetVpnGateway + for target VPN gateways.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetVpnGatewayList: + description: Contains a list of TargetVpnGateway resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of TargetVpnGateway resources. + items: + $ref: '#/components/schemas/TargetVpnGateway' + type: array + kind: + default: compute#targetVpnGatewayList + description: '[Output Only] Type of resource. Always compute#targetVpnGateway + for target VPN gateways.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TargetVpnGatewaysScopedList: + properties: + targetVpnGateways: + description: '[Output Only] A list of target VPN gateways contained in this + scope.' + items: + $ref: '#/components/schemas/TargetVpnGateway' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of addresses 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + TestFailure: + properties: + actualOutputUrl: + description: The actual output URL evaluated by load balancer containing + the scheme, host, path and query parameters. + type: string + actualRedirectResponseCode: + description: Actual HTTP status code for rule with `urlRedirect` calculated + by load balancer + format: int32 + type: integer + actualService: + description: BackendService or BackendBucket returned by load balancer. + type: string + expectedOutputUrl: + description: The expected output URL evaluated by load balancer containing + the scheme, host, path and query parameters. + type: string + expectedRedirectResponseCode: + description: Expected HTTP status code for rule with `urlRedirect` calculated + by load balancer + format: int32 + type: integer + expectedService: + description: Expected BackendService or BackendBucket resource the given + URL should be mapped to. + type: string + headers: + description: HTTP headers of the request. + items: + $ref: '#/components/schemas/UrlMapTestHeader' + type: array + host: + description: Host portion of the URL. + type: string + path: + description: Path portion including query parameters in the URL. + type: string + type: object + TestPermissionsRequest: + properties: + permissions: + description: The set of permissions to check for the 'resource'. Permissions + with wildcards (such as '*' or 'storage.*') are not allowed. + items: + type: string + type: array + type: object + TestPermissionsResponse: + properties: + permissions: + description: A subset of `TestPermissionsRequest.permissions` that the caller + is allowed. + items: + type: string + type: array + type: object + Uint128: + properties: + high: + format: uint64 + type: string + low: + format: uint64 + type: string + type: object + UrlMap: + description: 'Represents a URL Map resource. Google Compute Engine has two URL + Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) + A URL map resource is a component of certain types of GCP load balancers and + Traffic Director. * urlMaps are used by external HTTP(S) load balancers and + Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. + For a list of supported URL map features by load balancer type, see the Load + balancing features: Routing and traffic management table. For a list of supported + URL map features for Traffic Director, see the Traffic Director features: + Routing and traffic management table. This resource defines mappings from + host names and URL paths to either a backend service or a backend bucket. + To use the global urlMaps resource, the backend service must have a loadBalancingScheme + of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, + the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For + more information, read URL Map Concepts.' + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + defaultRouteAction: + $ref: '#/components/schemas/HttpRouteAction' + description: defaultRouteAction takes effect when none of the hostRules + match. The load balancer performs advanced routing actions like URL rewrites, + header transformations, etc. prior to forwarding the request to the selected + backend. If defaultRouteAction specifies any weightedBackendServices, + defaultService must not be set. Conversely if defaultService is set, defaultRouteAction + cannot contain any weightedBackendServices. Only one of defaultRouteAction + or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers + support only the urlRewrite action within defaultRouteAction. defaultRouteAction + has no effect when the URL map is bound to target gRPC proxy that has + validateForProxyless field set to true. + defaultService: + description: The full or partial URL of the defaultService resource to which + traffic is directed if none of the hostRules match. If defaultRouteAction + is additionally specified, advanced routing actions like URL Rewrites, + etc. take effect prior to sending the request to the backend. However, + if defaultService is specified, defaultRouteAction cannot contain any + weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, + service must not be specified. Only one of defaultService, defaultUrlRedirect + or defaultRouteAction.weightedBackendService must be set. defaultService + has no effect when the URL map is bound to target gRPC proxy that has + validateForProxyless field set to true. + type: string + defaultUrlRedirect: + $ref: '#/components/schemas/HttpRedirectAction' + description: When none of the specified hostRules match, the request is + redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect + is specified, defaultService or defaultRouteAction must not be set. Not + supported when the URL map is bound to target gRPC proxy. + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + fingerprint: + description: Fingerprint of this resource. A hash of the contents stored + in this object. This field is used in optimistic locking. This field will + be ignored when inserting a UrlMap. An up-to-date fingerprint must be + provided in order to update the UrlMap, otherwise the request will fail + with error 412 conditionNotMet. To see the latest fingerprint, make a + get() request to retrieve a UrlMap. + format: byte + type: string + headerAction: + $ref: '#/components/schemas/HttpHeaderAction' + description: Specifies changes to request and response headers that need + to take effect for the selected backendService. The headerAction specified + here take effect after headerAction specified under pathMatcher. Note + that headerAction is not supported for Loadbalancers that have their loadBalancingScheme + set to EXTERNAL. Not supported when the URL map is bound to target gRPC + proxy that has validateForProxyless field set to true. + hostRules: + description: The list of HostRules to use against the URL. + items: + $ref: '#/components/schemas/HostRule' + type: array + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#urlMap + description: '[Output Only] Type of the resource. Always compute#urlMaps + for url maps.' + type: string + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + pathMatchers: + description: The list of named PathMatchers to use against the URL. + items: + $ref: '#/components/schemas/PathMatcher' + type: array + region: + description: '[Output Only] URL of the region where the regional URL map + resides. This field is not applicable to global URL maps. You must specify + this field as part of the HTTP request URL. It is not settable as a field + in the request body.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + tests: + description: The list of expected URL mapping tests. Request to update this + UrlMap will succeed only if all of the test cases pass. You can specify + a maximum of 100 tests per UrlMap. Not supported when the URL map is bound + to target gRPC proxy that has validateForProxyless field set to true. + items: + $ref: '#/components/schemas/UrlMapTest' + type: array + type: object + UrlMapList: + description: Contains a list of UrlMap resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of UrlMap resources. + items: + $ref: '#/components/schemas/UrlMap' + type: array + kind: + default: compute#urlMapList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + UrlMapReference: + properties: + urlMap: + type: string + type: object + UrlMapTest: + description: Message for the expected URL mappings. + properties: + description: + description: Description of this test case. + type: string + expectedOutputUrl: + description: The expected output URL evaluated by load balancer containing + the scheme, host, path and query parameters. For rules that forward requests + to backends, the test passes only when expectedOutputUrl matches the request + forwarded by load balancer to backends. For rules with urlRewrite, the + test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite + in the urlRewrite action. When service is specified, expectedOutputUrl`s + scheme is ignored. For rules with urlRedirect, the test passes only if + expectedOutputUrl matches the URL in the load balancer's redirect response. + If urlRedirect specifies https_redirect, the test passes only if the scheme + in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, + the test passes only if expectedOutputUrl does not contain any query parameters. + expectedOutputUrl is optional when service is specified. + type: string + expectedRedirectResponseCode: + description: For rules with urlRedirect, the test passes only if expectedRedirectResponseCode + matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode + cannot be set when service is set. + format: int32 + type: integer + headers: + description: HTTP headers for this request. If headers contains a host header, + then host must also match the header value. + items: + $ref: '#/components/schemas/UrlMapTestHeader' + type: array + host: + description: Host portion of the URL. If headers contains a host header, + then host must also match the header value. + type: string + path: + description: Path portion of the URL. + type: string + service: + description: Expected BackendService or BackendBucket resource the given + URL should be mapped to. service cannot be set if expectedRedirectResponseCode + is set. + type: string + type: object + UrlMapTestHeader: + description: HTTP headers used in UrlMapTests. + properties: + name: + description: Header name. + type: string + value: + description: Header value. + type: string + type: object + UrlMapValidationResult: + description: Message representing the validation result for a UrlMap. + properties: + loadErrors: + items: + type: string + type: array + loadSucceeded: + description: Whether the given UrlMap can be successfully loaded. If false, + 'loadErrors' indicates the reasons. + type: boolean + testFailures: + items: + $ref: '#/components/schemas/TestFailure' + type: array + testPassed: + description: If successfully loaded, this field indicates whether the test + passed. If false, 'testFailures's indicate the reason of failure. + type: boolean + type: object + UrlMapsAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/UrlMapsScopedList' + description: Name of the scope containing this set of UrlMaps. + description: A list of UrlMapsScopedList resources. + type: object + kind: + default: compute#urlMapsAggregatedList + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + UrlMapsScopedList: + properties: + urlMaps: + description: A list of UrlMaps contained in this scope. + items: + $ref: '#/components/schemas/UrlMap' + type: array + warning: + description: Informational warning which replaces the list of backend services + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + UrlMapsValidateRequest: + properties: + resource: + $ref: '#/components/schemas/UrlMap' + description: Content of the UrlMap to be validated. + type: object + UrlMapsValidateResponse: + properties: + result: + $ref: '#/components/schemas/UrlMapValidationResult' + type: object + UrlRewrite: + description: The spec for modifying the path before sending the request to the + matched backend service. + properties: + hostRewrite: + description: Prior to forwarding the request to the selected service, the + request's host header is replaced with contents of hostRewrite. The value + must be between 1 and 255 characters. + type: string + pathPrefixRewrite: + description: Prior to forwarding the request to the selected backend service, + the matching portion of the request's path is replaced by pathPrefixRewrite. + The value must be between 1 and 1024 characters. + type: string + type: object + UsableSubnetwork: + description: Subnetwork which the current user has compute.subnetworks.use permission + on. + properties: + ipCidrRange: + description: The range of internal addresses that are owned by this subnetwork. + type: string + network: + description: Network URL. + type: string + secondaryIpRanges: + description: Secondary IP ranges. + items: + $ref: '#/components/schemas/UsableSubnetworkSecondaryRange' + type: array + subnetwork: + description: Subnetwork URL. + type: string + type: object + UsableSubnetworkSecondaryRange: + description: Secondary IP range of a usable subnetwork. + properties: + ipCidrRange: + description: The range of IP addresses belonging to this subnetwork secondary + range. + type: string + rangeName: + description: The name associated with this subnetwork secondary range, used + when adding an alias IP range to a VM instance. The name must be 1-63 + characters long, and comply with RFC1035. The name must be unique within + the subnetwork. + type: string + type: object + UsableSubnetworksAggregatedList: + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + items: + description: '[Output] A list of usable subnetwork URLs.' + items: + $ref: '#/components/schemas/UsableSubnetwork' + type: array + kind: + default: compute#usableSubnetworksAggregatedList + description: '[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList + for aggregated lists of usable subnetworks.' + 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. In special cases listUsable may + return 0 subnetworks and nextPageToken which still should be used to get + the next page of 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + UsageExportLocation: + description: The location in Cloud Storage and naming method of the daily usage + report. Contains bucket_name and report_name prefix. + properties: + bucketName: + description: The name of an existing bucket in Cloud Storage where the usage + report object is stored. The Google Service Account is granted write access + to this bucket. This can either be the bucket name by itself, such as + example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ + in front of it, such as gs://example-bucket. + type: string + reportNamePrefix: + description: An optional prefix for the name of the usage report object + stored in bucketName. If not supplied, defaults to usage_gce. The report + is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where + YYYYMMDD is the day of the usage according to Pacific Time. If you supply + a prefix, it should conform to Cloud Storage object naming conventions. + type: string + type: object + VmEndpointNatMappings: + description: Contain information of Nat mapping for a VM endpoint (i.e., NIC). + properties: + instanceName: + description: Name of the VM instance which the endpoint belongs to + type: string + interfaceNatMappings: + items: + $ref: '#/components/schemas/VmEndpointNatMappingsInterfaceNatMappings' + type: array + type: object + VmEndpointNatMappingsInterfaceNatMappings: + description: Contain information of Nat mapping for an interface of this endpoint. + properties: + drainNatIpPortRanges: + description: 'List of all drain IP:port-range mappings assigned to this + interface. These ranges are inclusive, that is, both the first and the + last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].' + items: + type: string + type: array + natIpPortRanges: + description: 'A list of all IP:port-range mappings assigned to this interface. + These ranges are inclusive, that is, both the first and the last ports + can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].' + items: + type: string + type: array + numTotalDrainNatPorts: + description: Total number of drain ports across all NAT IPs allocated to + this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges. + format: int32 + type: integer + numTotalNatPorts: + description: Total number of ports across all NAT IPs allocated to this + interface. It equals to the aggregated port number in the field nat_ip_port_ranges. + format: int32 + type: integer + sourceAliasIpRange: + description: 'Alias IP range for this interface endpoint. It will be a private + (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24".' + type: string + sourceVirtualIp: + description: Primary IP of the VM for this NIC. + type: string + type: object + VmEndpointNatMappingsList: + description: Contains a list of VmEndpointNatMappings. + properties: + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + type: string + kind: + default: compute#vmEndpointNatMappingsList + description: '[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList + for lists of Nat mappings of VM endpoints.' + 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 + result: + description: '[Output Only] A list of Nat mapping information of VM endpoints.' + items: + $ref: '#/components/schemas/VmEndpointNatMappings' + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnGateway: + description: Represents a HA VPN gateway. HA VPN is a high-availability (HA) + Cloud VPN solution that lets you securely connect your on-premises network + to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection + in a single region. For more information about Cloud HA VPN solutions, see + Cloud VPN topologies . + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#vpnGateway + description: '[Output Only] Type of resource. Always compute#vpnGateway + for VPN gateways.' + type: string + labelFingerprint: + description: A fingerprint for the labels being applied to this VpnGateway, + which is essentially a hash of the labels set used for optimistic locking. + The fingerprint is initially generated by Compute Engine and changes after + every request to modify or update labels. You must always provide an up-to-date + fingerprint hash in order to update or change labels, otherwise the request + will fail with error 412 conditionNotMet. To see the latest fingerprint, + make a get() request to retrieve an VpnGateway. + format: byte + type: string + labels: + additionalProperties: + type: string + description: Labels for this resource. These can only be added or modified + by the setLabels method. Each label key/value pair must comply with RFC1035. + Label values may be empty. + type: object + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + network: + description: URL of the network to which this VPN gateway is attached. Provided + by the client when the VPN gateway is created. + type: string + region: + description: '[Output Only] URL of the region where the VPN gateway resides.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + vpnInterfaces: + description: The list of VPN interfaces associated with this VPN gateway. + items: + $ref: '#/components/schemas/VpnGatewayVpnGatewayInterface' + type: array + type: object + VpnGatewayAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/VpnGatewaysScopedList' + description: '[Output Only] Name of the scope containing this set of VPN + gateways.' + description: A list of VpnGateway resources. + type: object + kind: + default: compute#vpnGatewayAggregatedList + description: '[Output Only] Type of resource. Always compute#vpnGateway + for VPN gateways.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnGatewayList: + description: Contains a list of VpnGateway resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of VpnGateway resources. + items: + $ref: '#/components/schemas/VpnGateway' + type: array + kind: + default: compute#vpnGatewayList + description: '[Output Only] Type of resource. Always compute#vpnGateway + for VPN gateways.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnGatewayStatus: + properties: + vpnConnections: + description: List of VPN connection for this VpnGateway. + items: + $ref: '#/components/schemas/VpnGatewayStatusVpnConnection' + type: array + type: object + VpnGatewayStatusHighAvailabilityRequirementState: + description: Describes the high availability requirement state for the VPN connection + between this Cloud VPN gateway and a peer gateway. + properties: + state: + description: Indicates the high availability requirement state for the VPN + connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. + enum: + - CONNECTION_REDUNDANCY_MET + - CONNECTION_REDUNDANCY_NOT_MET + type: string + unsatisfiedReason: + description: Indicates the reason why the VPN connection does not meet the + high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. + enum: + - INCOMPLETE_TUNNELS_COVERAGE + type: string + type: object + VpnGatewayStatusTunnel: + description: Contains some information about a VPN tunnel. + properties: + localGatewayInterface: + description: The VPN gateway interface this VPN tunnel is associated with. + format: uint32 + type: integer + peerGatewayInterface: + description: The peer gateway interface this VPN tunnel is connected to, + the peer gateway could either be an external VPN gateway or GCP VPN gateway. + format: uint32 + type: integer + tunnelUrl: + description: URL reference to the VPN tunnel. + type: string + type: object + VpnGatewayStatusVpnConnection: + description: A VPN connection contains all VPN tunnels connected from this VpnGateway + to the same peer gateway. The peer gateway could either be a external VPN + gateway or GCP VPN gateway. + properties: + peerExternalGateway: + description: URL reference to the peer external VPN gateways to which the + VPN tunnels in this VPN connection are connected. This field is mutually + exclusive with peer_gcp_gateway. + type: string + peerGcpGateway: + description: URL reference to the peer side VPN gateways to which the VPN + tunnels in this VPN connection are connected. This field is mutually exclusive + with peer_gcp_gateway. + type: string + state: + $ref: '#/components/schemas/VpnGatewayStatusHighAvailabilityRequirementState' + description: HighAvailabilityRequirementState for the VPN connection. + tunnels: + description: List of VPN tunnels that are in this VPN connection. + items: + $ref: '#/components/schemas/VpnGatewayStatusTunnel' + type: array + type: object + VpnGatewayVpnGatewayInterface: + description: A VPN gateway interface. + properties: + id: + description: '[Output Only] Numeric identifier for this VPN interface associated + with the VPN gateway.' + format: uint32 + type: integer + interconnectAttachment: + description: 'URL of the VLAN attachment (interconnectAttachment) resource + for this VPN gateway interface. When the value of this field is present, + the VPN gateway is used for IPsec-encrypted Cloud Interconnect; all egress + or ingress traffic for this VPN gateway interface goes through the specified + VLAN attachment resource. Not currently available publicly. ' + type: string + ipAddress: + description: '[Output Only] IP address for this VPN interface associated + with the VPN gateway. The IP address could be either a regional external + IP address or a regional internal IP address. The two IP addresses for + a VPN gateway must be all regional external or regional internal IP addresses. + There cannot be a mix of regional external IP addresses and regional internal + IP addresses. For IPsec-encrypted Cloud Interconnect, the IP addresses + for both interfaces could either be regional internal IP addresses or + regional external IP addresses. For regular (non IPsec-encrypted Cloud + Interconnect) HA VPN tunnels, the IP address must be a regional external + IP address.' + type: string + type: object + VpnGatewaysGetStatusResponse: + properties: + result: + $ref: '#/components/schemas/VpnGatewayStatus' + type: object + VpnGatewaysScopedList: + properties: + vpnGateways: + description: '[Output Only] A list of VPN gateways contained in this scope.' + items: + $ref: '#/components/schemas/VpnGateway' + type: array + warning: + description: '[Output Only] Informational warning which replaces the list + of addresses 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnTunnel: + description: Represents a Cloud VPN Tunnel resource. For more information about + VPN, read the the Cloud VPN Overview. + properties: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: An optional description of this resource. Provide this property + when you create the resource. + type: string + detailedStatus: + description: '[Output Only] Detailed status message for the VPN tunnel.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + ikeVersion: + description: IKE protocol version to use when establishing the VPN tunnel + with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default + version is 2. + format: int32 + type: integer + kind: + default: compute#vpnTunnel + description: '[Output Only] Type of resource. Always compute#vpnTunnel for + VPN tunnels.' + type: string + localTrafficSelector: + description: 'Local traffic selector to use when establishing the VPN tunnel + with the peer VPN gateway. The value should be a CIDR formatted string, + for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is + supported.' + items: + type: string + type: array + name: + description: 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. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + peerExternalGateway: + description: URL of the peer side external VPN gateway to which this VPN + tunnel is connected. Provided by the client when the VPN tunnel is created. + This field is exclusive with the field peerGcpGateway. + type: string + peerExternalGatewayInterface: + description: The interface ID of the external VPN gateway to which this + VPN tunnel is connected. Provided by the client when the VPN tunnel is + created. + format: int32 + type: integer + peerGcpGateway: + description: URL of the peer side HA GCP VPN gateway to which this VPN tunnel + is connected. Provided by the client when the VPN tunnel is created. This + field can be used when creating highly available VPN from VPC network + to VPC network, the field is exclusive with the field peerExternalGateway. + If provided, the VPN tunnel will automatically use the same vpnGatewayInterface + ID in the peer GCP VPN gateway. + type: string + peerIp: + description: IP address of the peer VPN gateway. Only IPv4 is supported. + type: string + region: + description: '[Output Only] URL of the region where the VPN tunnel resides. + You must specify this field as part of the HTTP request URL. It is not + settable as a field in the request body.' + type: string + remoteTrafficSelector: + description: 'Remote traffic selectors to use when establishing the VPN + tunnel with the peer VPN gateway. The value should be a CIDR formatted + string, for example: 192.168.0.0/16. The ranges should be disjoint. Only + IPv4 is supported.' + items: + type: string + type: array + router: + description: URL of the router resource to be used for dynamic routing. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + sharedSecret: + description: Shared secret used to set the secure session between the Cloud + VPN gateway and the peer VPN gateway. + type: string + sharedSecretHash: + description: Hash of the shared secret. + type: string + status: + description: '[Output Only] The status of the VPN tunnel, which can be one + of the following: - PROVISIONING: Resource is being allocated for the + VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related + configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, + and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: + Successful first handshake with the peer VPN. - ESTABLISHED: Secure session + is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, + replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for + example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. + - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. + - FAILED: Tunnel creation has failed and the tunnel is not ready to be + used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: + Tunnel configuration was rejected, can be result of being denied access. + - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all + required resources. - STOPPED: Tunnel is stopped due to its Forwarding + Rules being deleted for Classic VPN tunnels or the project is in frozen + state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, + probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing + not allowed for an HA-VPN tunnel. ' + enum: + - ALLOCATING_RESOURCES + - AUTHORIZATION_ERROR + - DEPROVISIONING + - ESTABLISHED + - FAILED + - FIRST_HANDSHAKE + - NEGOTIATION_FAILURE + - NETWORK_ERROR + - NO_INCOMING_PACKETS + - PROVISIONING + - REJECTED + - STOPPED + - WAITING_FOR_FULL_CONFIG + type: string + targetVpnGateway: + description: URL of the Target VPN gateway with which this VPN tunnel is + associated. Provided by the client when the VPN tunnel is created. + type: string + vpnGateway: + description: URL of the VPN gateway with which this VPN tunnel is associated. + Provided by the client when the VPN tunnel is created. This must be used + (instead of target_vpn_gateway) if a High Availability VPN gateway resource + is created. + type: string + vpnGatewayInterface: + description: The interface ID of the VPN gateway with which this VPN tunnel + is associated. + format: int32 + type: integer + type: object + VpnTunnelAggregatedList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + additionalProperties: + $ref: '#/components/schemas/VpnTunnelsScopedList' + description: Name of the scope containing this set of VPN tunnels. + description: A list of VpnTunnelsScopedList resources. + type: object + kind: + default: compute#vpnTunnelAggregatedList + description: '[Output Only] Type of resource. Always compute#vpnTunnel for + VPN tunnels.' + 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 + unreachables: + description: '[Output Only] Unreachable resources.' + items: + type: string + type: array + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnTunnelList: + description: Contains a list of VpnTunnel resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of VpnTunnel resources. + items: + $ref: '#/components/schemas/VpnTunnel' + type: array + kind: + default: compute#vpnTunnelList + description: '[Output Only] Type of resource. Always compute#vpnTunnel for + VPN tunnels.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + VpnTunnelsScopedList: + properties: + vpnTunnels: + description: A list of VPN tunnels contained in this scope. + items: + $ref: '#/components/schemas/VpnTunnel' + type: array + warning: + description: Informational warning which replaces the list of addresses + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + WafExpressionSet: + properties: + aliases: + description: 'A list of alternate IDs. The format should be: - E.g. XSS-stable + Generic suffix like "stable" is particularly useful if a policy likes + to avail newer set of expressions without having to change the policy. + A given alias name can''t be used for more than one entity set.' + items: + type: string + type: array + expressions: + description: List of available expressions. + items: + $ref: '#/components/schemas/WafExpressionSetExpression' + type: array + id: + description: 'Google specified expression set ID. The format should be: + - E.g. XSS-20170329 required' + type: string + type: object + WafExpressionSetExpression: + properties: + id: + description: Expression ID should uniquely identify the origin of the expression. + E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version + 2.9.1 rule id 973337. The ID could be used to determine the individual + attack definition that has been detected. It could also be used to exclude + it from the policy in case of false positive. required + type: string + type: object + WeightedBackendService: + description: In contrast to a single BackendService in HttpRouteAction to which + all matching traffic is directed to, WeightedBackendService allows traffic + to be split across multiple BackendServices. The volume of traffic for each + BackendService is proportional to the weight specified in each WeightedBackendService + properties: + backendService: + description: The full or partial URL to the default BackendService resource. + Before forwarding the request to backendService, the loadbalancer applies + any relevant headerActions specified as part of this backendServiceWeight. + type: string + headerAction: + $ref: '#/components/schemas/HttpHeaderAction' + description: Specifies changes to request and response headers that need + to take effect for the selected backendService. headerAction specified + here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher + and UrlMap. Note that headerAction is not supported for Loadbalancers + that have their loadBalancingScheme set to EXTERNAL. Not supported when + the URL map is bound to target gRPC proxy that has validateForProxyless + field set to true. + weight: + description: Specifies the fraction of traffic sent to backendService, computed + as weight / (sum of all weightedBackendService weights in routeAction) + . The selection of a backend service is determined only for new traffic. + Once a user's request has been directed to a backendService, subsequent + requests will be sent to the same backendService as determined by the + BackendService's session affinity policy. The value must be between 0 + and 1000 + format: uint32 + type: integer + type: object + XpnHostList: + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: '[Output Only] A list of shared VPC host project URLs.' + items: + $ref: '#/components/schemas/Project' + type: array + kind: + default: compute#xpnHostList + description: '[Output Only] Type of resource. Always compute#xpnHostList + for lists of shared VPC hosts.' + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + XpnResourceId: + description: Service resource (a.k.a service project) ID. + properties: + id: + description: The ID of the service resource. In the case of projects, this + field supports project id (e.g., my-project-123) and project number (e.g. + 12345678). + type: string + type: + description: The type of the service resource. + enum: + - PROJECT + - XPN_RESOURCE_TYPE_UNSPECIFIED + type: string + type: object + Zone: + description: Represents a Zone resource. A zone is a deployment area. These + deployment areas are subsets of a region. For example the zone us-east1-a + is located in the us-east1 region. For more information, read Regions and + Zones. + properties: + availableCpuPlatforms: + description: '[Output Only] Available cpu/platform selections for the zone.' + items: + type: string + type: array + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + deprecated: + $ref: '#/components/schemas/DeprecationStatus' + description: '[Output Only] The deprecation status associated with this + zone.' + description: + description: '[Output Only] Textual description of the resource.' + type: string + id: + description: '[Output Only] The unique identifier for the resource. This + identifier is defined by the server.' + format: uint64 + type: string + kind: + default: compute#zone + description: '[Output Only] Type of the resource. Always compute#zone for + zones.' + type: string + name: + description: '[Output Only] Name of the resource.' + type: string + region: + description: '[Output Only] Full URL reference to the region which hosts + the zone.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: '[Output Only] Status of the zone, either UP or DOWN.' + enum: + - DOWN + - UP + type: string + supportsPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + type: object + ZoneList: + description: Contains a list of zone resources. + properties: + id: + description: '[Output Only] Unique identifier for the resource; defined + by the server.' + type: string + items: + description: A list of Zone resources. + items: + $ref: '#/components/schemas/Zone' + type: array + kind: + default: compute#zoneList + 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 + - LARGE_DEPLOYMENT_WARNING + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - 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 + 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 + ZoneSetLabelsRequest: + properties: + labelFingerprint: + description: The fingerprint of the previous set of labels for this resource, + used to detect conflicts. The fingerprint is initially generated by Compute + Engine and changes after every request to modify or update labels. You + must always provide an up-to-date fingerprint hash in order to update + or change labels. Make a get() request to the resource to get the latest + fingerprint. + format: byte + type: string + labels: + additionalProperties: + type: string + description: The labels to set for this resource. + type: object + type: object + ZoneSetPolicyRequest: + properties: + bindings: + description: Flatten Policy to create a backwacd compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + format: byte + type: string + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the ''resource''. + The size of the policy is limited to a few 10s of KB. An empty policy + is in general a valid policy but certain services (like Projects) might + reject them.' + type: object + securitySchemes: + Oauth2: + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + https://www.googleapis.com/auth/compute: View and manage your Google Compute + Engine resources + https://www.googleapis.com/auth/compute.readonly: View your Google Compute + Engine resources + https://www.googleapis.com/auth/devstorage.full_control: Manage your data + and permissions in Cloud Storage and see the email address for your + Google Account + https://www.googleapis.com/auth/devstorage.read_only: View your data in + Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_write: Manage your data + in Cloud Storage and see the email address of your Google Account + type: oauth2 + Oauth2c: + description: Oauth 2.0 authorizationCode authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + https://www.googleapis.com/auth/compute: View and manage your Google Compute + Engine resources + https://www.googleapis.com/auth/compute.readonly: View your Google Compute + Engine resources + https://www.googleapis.com/auth/devstorage.full_control: Manage your data + and permissions in Cloud Storage and see the email address for your + Google Account + https://www.googleapis.com/auth/devstorage.read_only: View your data in + Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_write: Manage your data + in Cloud Storage and see the email address of your Google Account + tokenUrl: https://accounts.google.com/o/oauth2/token + type: oauth2 + x-stackQL-resources: + acceleratorTypes: + id: google.compute.acceleratorTypes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/acceleratorTypes + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/acceleratorTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: acceleratorTypes + title: acceleratorTypes + addresses: + id: google.compute.addresses + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/addresses + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/addresses/{address} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/addresses/{address} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/addresses + request: + mediaType: application/json + required: + - name + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/addresses + response: + mediaType: application/json + openAPIDocKey: '200' + name: addresses + title: addresses + autoscalers: + id: google.compute.autoscalers + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/autoscalers + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/autoscalers/{autoscaler} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/autoscalers/{autoscaler} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/autoscalers + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/zones/{zone}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: autoscalers + title: autoscalers + backendBuckets: + id: google.compute.backendBuckets + methods: + addSignedUrlKey: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteSignedUrlKey: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendBuckets + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/backendBuckets + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/backendBuckets/{backendBucket} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: backendBuckets + title: backendBuckets + backendServices: + id: google.compute.backendServices + methods: + addSignedUrlKey: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices/{backendService}/addSignedUrlKey + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/backendServices + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/backendServices/{backendService} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteSignedUrlKey: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/backendServices/{backendService} + response: + mediaType: application/json + openAPIDocKey: '200' + getHealth: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices/{backendService}/getHealth + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/backendServices + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/backendServices/{backendService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSecurityPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/backendServices/{backendService}/setSecurityPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/backendServices/{backendService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: backendServices + title: backendServices + diskTypes: + id: google.compute.diskTypes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/diskTypes + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/diskTypes/{diskType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/diskTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: diskTypes + title: diskTypes + disks: + id: google.compute.disks + methods: + addResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/disks + response: + mediaType: application/json + openAPIDocKey: '200' + createSnapshot: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk}/createSnapshot + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/disks + response: + mediaType: application/json + openAPIDocKey: '200' + removeResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{disk}/resize + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: disks + title: disks + externalVpnGateways: + id: google.compute.externalVpnGateways + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/externalVpnGateways/{externalVpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/externalVpnGateways/{externalVpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/externalVpnGateways + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/externalVpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/global/externalVpnGateways/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: externalVpnGateways + title: externalVpnGateways + firewallPolicies: + id: google.compute.firewallPolicies + methods: + addAssociation: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/addAssociation + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + addRule: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/addRule + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + cloneRules: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/cloneRules + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + getAssociation: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/getAssociation + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + getRule: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/getRule + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies + response: + mediaType: application/json + openAPIDocKey: '200' + listAssociations: + operation: + $ref: get + path: + $ref: /locations/global/firewallPolicies/listAssociations + response: + mediaType: application/json + openAPIDocKey: '200' + move: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/move + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patchRule: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/patchRule + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removeAssociation: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/removeAssociation + response: + mediaType: application/json + openAPIDocKey: '200' + removeRule: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{firewallPolicy}/removeRule + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /locations/global/firewallPolicies/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: firewallPolicies + title: firewallPolicies + firewalls: + id: google.compute.firewalls + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/firewalls/{firewall} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/firewalls/{firewall} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/firewalls + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/firewalls + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/firewalls/{firewall} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/firewalls/{firewall} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: firewalls + title: firewalls + forwardingRules: + id: google.compute.forwardingRules + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/forwardingRules + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{forwardingRule} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{forwardingRule} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/forwardingRules + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/forwardingRules + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{forwardingRule} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTarget: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: forwardingRules + title: forwardingRules + globalAddresses: + id: google.compute.globalAddresses + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/addresses/{address} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/addresses/{address} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/addresses + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/addresses + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalAddresses + title: globalAddresses + globalForwardingRules: + id: google.compute.globalForwardingRules + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/forwardingRules/{forwardingRule} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/forwardingRules/{forwardingRule} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/forwardingRules + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/forwardingRules + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/forwardingRules/{forwardingRule} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/global/forwardingRules/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTarget: + operation: + $ref: post + path: + $ref: /projects/{project}/global/forwardingRules/{forwardingRule}/setTarget + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalForwardingRules + title: globalForwardingRules + globalNetworkEndpointGroups: + id: google.compute.globalNetworkEndpointGroups + methods: + attachNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + detachNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networkEndpointGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networkEndpointGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalNetworkEndpointGroups + title: globalNetworkEndpointGroups + globalOperations: + id: google.compute.globalOperations + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/operations + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/operations/{operation} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/operations/{operation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/operations + response: + mediaType: application/json + openAPIDocKey: '200' + wait: + operation: + $ref: post + path: + $ref: /projects/{project}/global/operations/{operation}/wait + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalOperations + title: globalOperations + globalOrganizationOperations: + id: google.compute.globalOrganizationOperations + methods: + delete: + operation: + $ref: delete + path: + $ref: /locations/global/operations/{operation} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /locations/global/operations/{operation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /locations/global/operations + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalOrganizationOperations + title: globalOrganizationOperations + globalPublicDelegatedPrefixes: + id: google.compute.globalPublicDelegatedPrefixes + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: globalPublicDelegatedPrefixes + title: globalPublicDelegatedPrefixes + healthChecks: + id: google.compute.healthChecks + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/healthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/healthChecks/{healthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/healthChecks/{healthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/healthChecks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/healthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/healthChecks/{healthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/healthChecks/{healthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: healthChecks + title: healthChecks + httpHealthChecks: + id: google.compute.httpHealthChecks + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/httpHealthChecks/{httpHealthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/httpHealthChecks/{httpHealthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/httpHealthChecks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/httpHealthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/httpHealthChecks/{httpHealthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/httpHealthChecks/{httpHealthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: httpHealthChecks + title: httpHealthChecks + httpsHealthChecks: + id: google.compute.httpsHealthChecks + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/httpsHealthChecks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/httpsHealthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: httpsHealthChecks + title: httpsHealthChecks + imageFamilyViews: + id: google.compute.imageFamilyViews + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/imageFamilyViews/{family} + response: + mediaType: application/json + openAPIDocKey: '200' + name: imageFamilyViews + title: imageFamilyViews + images: + id: google.compute.images + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/images/{image} + response: + mediaType: application/json + openAPIDocKey: '200' + deprecate: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images/{image}/deprecate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/images/{image} + response: + mediaType: application/json + openAPIDocKey: '200' + getFromFamily: + operation: + $ref: get + path: + $ref: /projects/{project}/global/images/family/{family} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/global/images/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/images + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/images/{image} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/images/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: images + title: images + instanceGroupManagers: + id: google.compute.instanceGroupManagers + methods: + abandonInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/instanceGroupManagers + response: + mediaType: application/json + openAPIDocKey: '200' + applyUpdatesToInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + createInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + deletePerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers + response: + mediaType: application/json + openAPIDocKey: '200' + listErrors: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors + response: + mediaType: application/json + openAPIDocKey: '200' + listManagedInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances + response: + mediaType: application/json + openAPIDocKey: '200' + listPerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patchPerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + recreateInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize + response: + mediaType: application/json + openAPIDocKey: '200' + setInstanceTemplate: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTargetPools: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updatePerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: instanceGroupManagers + title: instanceGroupManagers + instanceGroups: + id: google.compute.instanceGroups + methods: + addInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/instanceGroups + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removeInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setNamedPorts: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: instanceGroups + title: instanceGroups + instanceTemplates: + id: google.compute.instanceTemplates + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/instanceTemplates/{instanceTemplate} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/instanceTemplates/{instanceTemplate} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/global/instanceTemplates/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/instanceTemplates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/instanceTemplates + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/instanceTemplates/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/instanceTemplates/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: instanceTemplates + title: instanceTemplates + instances: + id: google.compute.instances + methods: + addAccessConfig: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + addResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/instances + response: + mediaType: application/json + openAPIDocKey: '200' + attachDisk: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/attachDisk + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + bulkInsert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/bulkInsert + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteAccessConfig: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig + response: + mediaType: application/json + openAPIDocKey: '200' + detachDisk: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/detachDisk + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance} + response: + mediaType: application/json + openAPIDocKey: '200' + getEffectiveFirewalls: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls + response: + mediaType: application/json + openAPIDocKey: '200' + getGuestAttributes: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + getScreenshot: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/screenshot + response: + mediaType: application/json + openAPIDocKey: '200' + getSerialPortOutput: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/serialPort + response: + mediaType: application/json + openAPIDocKey: '200' + getShieldedInstanceIdentity: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances + response: + mediaType: application/json + openAPIDocKey: '200' + listReferrers: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/referrers + response: + mediaType: application/json + openAPIDocKey: '200' + removeResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + reset: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/reset + response: + mediaType: application/json + openAPIDocKey: '200' + sendDiagnosticInterrupt: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt + response: + openAPIDocKey: '200' + setDeletionProtection: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection + response: + mediaType: application/json + openAPIDocKey: '200' + setDiskAutoDelete: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMachineResources: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setMachineResources + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMachineType: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setMachineType + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMetadata: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setMetadata + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMinCpuPlatform: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setScheduling: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setScheduling + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setServiceAccount: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setShieldedInstanceIntegrityPolicy: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTags: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/setTags + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + simulateMaintenanceEvent: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent + response: + mediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/start + response: + mediaType: application/json + openAPIDocKey: '200' + startWithEncryptionKey: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/stop + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateAccessConfig: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateDisplayDevice: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateNetworkInterface: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateShieldedInstanceConfig: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: instances + title: instances + interconnectAttachments: + id: google.compute.interconnectAttachments + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/interconnectAttachments + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: interconnectAttachments + title: interconnectAttachments + interconnectLocations: + id: google.compute.interconnectLocations + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnectLocations/{interconnectLocation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnectLocations + response: + mediaType: application/json + openAPIDocKey: '200' + name: interconnectLocations + title: interconnectLocations + interconnects: + id: google.compute.interconnects + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/interconnects/{interconnect} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnects/{interconnect} + response: + mediaType: application/json + openAPIDocKey: '200' + getDiagnostics: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnects/{interconnect}/getDiagnostics + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/interconnects + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/interconnects + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/interconnects/{interconnect} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: interconnects + title: interconnects + licenseCodes: + id: google.compute.licenseCodes + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/licenseCodes/{licenseCode} + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/licenseCodes/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: licenseCodes + title: licenseCodes + licenses: + id: google.compute.licenses + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/licenses/{license} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/licenses/{license} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/global/licenses/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/licenses + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/licenses + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/licenses/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/licenses/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: licenses + title: licenses + machineTypes: + id: google.compute.machineTypes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/machineTypes + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/machineTypes/{machineType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/machineTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: machineTypes + title: machineTypes + networkEndpointGroups: + id: google.compute.networkEndpointGroups + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/networkEndpointGroups + response: + mediaType: application/json + openAPIDocKey: '200' + attachNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + detachNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listNetworkEndpoints: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: networkEndpointGroups + title: networkEndpointGroups + networks: + id: google.compute.networks + methods: + addPeering: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networks/{network}/addPeering + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/networks/{network} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networks/{network} + response: + mediaType: application/json + openAPIDocKey: '200' + getEffectiveFirewalls: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networks/{network}/getEffectiveFirewalls + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networks + response: + mediaType: application/json + openAPIDocKey: '200' + listPeeringRoutes: + operation: + $ref: get + path: + $ref: /projects/{project}/global/networks/{network}/listPeeringRoutes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/networks/{network} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removePeering: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networks/{network}/removePeering + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + switchToCustomMode: + operation: + $ref: post + path: + $ref: /projects/{project}/global/networks/{network}/switchToCustomMode + response: + mediaType: application/json + openAPIDocKey: '200' + updatePeering: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/networks/{network}/updatePeering + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: networks + title: networks + nodeGroups: + id: google.compute.nodeGroups + methods: + addNodes: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/nodeGroups + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteNodes: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listNodes: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setNodeTemplate: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: nodeGroups + title: nodeGroups + nodeTemplates: + id: google.compute.nodeTemplates + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/nodeTemplates + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: nodeTemplates + title: nodeTemplates + nodeTypes: + id: google.compute.nodeTypes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/nodeTypes + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeTypes/{nodeType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/nodeTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: nodeTypes + title: nodeTypes + packetMirrorings: + id: google.compute.packetMirrorings + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/packetMirrorings + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: packetMirrorings + title: packetMirrorings + projects: + id: google.compute.projects + methods: + disableXpnHost: + operation: + $ref: post + path: + $ref: /projects/{project}/disableXpnHost + response: + mediaType: application/json + openAPIDocKey: '200' + disableXpnResource: + operation: + $ref: post + path: + $ref: /projects/{project}/disableXpnResource + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + enableXpnHost: + operation: + $ref: post + path: + $ref: /projects/{project}/enableXpnHost + response: + mediaType: application/json + openAPIDocKey: '200' + enableXpnResource: + operation: + $ref: post + path: + $ref: /projects/{project}/enableXpnResource + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project} + response: + mediaType: application/json + openAPIDocKey: '200' + getXpnHost: + operation: + $ref: get + path: + $ref: /projects/{project}/getXpnHost + response: + mediaType: application/json + openAPIDocKey: '200' + getXpnResources: + operation: + $ref: get + path: + $ref: /projects/{project}/getXpnResources + response: + mediaType: application/json + openAPIDocKey: '200' + listXpnHosts: + operation: + $ref: post + path: + $ref: /projects/{project}/listXpnHosts + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + moveDisk: + operation: + $ref: post + path: + $ref: /projects/{project}/moveDisk + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + moveInstance: + operation: + $ref: post + path: + $ref: /projects/{project}/moveInstance + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setCommonInstanceMetadata: + operation: + $ref: post + path: + $ref: /projects/{project}/setCommonInstanceMetadata + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setDefaultNetworkTier: + operation: + $ref: post + path: + $ref: /projects/{project}/setDefaultNetworkTier + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setUsageExportBucket: + operation: + $ref: post + path: + $ref: /projects/{project}/setUsageExportBucket + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects + title: projects + publicAdvertisedPrefixes: + id: google.compute.publicAdvertisedPrefixes + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: publicAdvertisedPrefixes + title: publicAdvertisedPrefixes + publicDelegatedPrefixes: + id: google.compute.publicDelegatedPrefixes + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/publicDelegatedPrefixes + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: publicDelegatedPrefixes + title: publicDelegatedPrefixes + regionAutoscalers: + id: google.compute.regionAutoscalers + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/autoscalers/{autoscaler} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/autoscalers/{autoscaler} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/autoscalers + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/autoscalers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionAutoscalers + title: regionAutoscalers + regionBackendServices: + id: google.compute.regionBackendServices + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService} + response: + mediaType: application/json + openAPIDocKey: '200' + getHealth: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService}/getHealth + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/backendServices + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/backendServices + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/backendServices/{backendService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionBackendServices + title: regionBackendServices + regionCommitments: + id: google.compute.regionCommitments + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/commitments + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/commitments/{commitment} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/commitments + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/commitments + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionCommitments + title: regionCommitments + regionDiskTypes: + id: google.compute.regionDiskTypes + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/diskTypes/{diskType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/diskTypes + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionDiskTypes + title: regionDiskTypes + regionDisks: + id: google.compute.regionDisks + methods: + addResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + createSnapshot: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{disk}/createSnapshot + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/disks/{disk} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/disks/{disk} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/disks/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/disks + response: + mediaType: application/json + openAPIDocKey: '200' + removeResourcePolicies: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{disk}/resize + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/disks/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionDisks + title: regionDisks + regionHealthCheckServices: + id: google.compute.regionHealthCheckServices + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionHealthCheckServices + title: regionHealthCheckServices + regionHealthChecks: + id: google.compute.regionHealthChecks + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/healthChecks/{healthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/healthChecks/{healthCheck} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/healthChecks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/healthChecks + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/healthChecks/{healthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/healthChecks/{healthCheck} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionHealthChecks + title: regionHealthChecks + regionInstanceGroupManagers: + id: google.compute.regionInstanceGroupManagers + methods: + abandonInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + applyUpdatesToInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + createInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager} + response: + mediaType: application/json + openAPIDocKey: '200' + deleteInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + deletePerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers + response: + mediaType: application/json + openAPIDocKey: '200' + listErrors: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors + response: + mediaType: application/json + openAPIDocKey: '200' + listManagedInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances + response: + mediaType: application/json + openAPIDocKey: '200' + listPerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patchPerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + recreateInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize + response: + mediaType: application/json + openAPIDocKey: '200' + setInstanceTemplate: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setTargetPools: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updatePerInstanceConfigs: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionInstanceGroupManagers + title: regionInstanceGroupManagers + regionInstanceGroups: + id: google.compute.regionInstanceGroups + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroups/{instanceGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/instanceGroups + response: + mediaType: application/json + openAPIDocKey: '200' + listInstances: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setNamedPorts: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionInstanceGroups + title: regionInstanceGroups + regionInstances: + id: google.compute.regionInstances + methods: + bulkInsert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/instances/bulkInsert + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionInstances + title: regionInstances + regionNetworkEndpointGroups: + id: google.compute.regionNetworkEndpointGroups + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/networkEndpointGroups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/networkEndpointGroups + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionNetworkEndpointGroups + title: regionNetworkEndpointGroups + regionNotificationEndpoints: + id: google.compute.regionNotificationEndpoints + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/notificationEndpoints + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/notificationEndpoints + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionNotificationEndpoints + title: regionNotificationEndpoints + regionOperations: + id: google.compute.regionOperations + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/operations/{operation} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/operations/{operation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/operations + response: + mediaType: application/json + openAPIDocKey: '200' + wait: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/operations/{operation}/wait + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionOperations + title: regionOperations + regionSslCertificates: + id: google.compute.regionSslCertificates + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/sslCertificates/{sslCertificate} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/sslCertificates/{sslCertificate} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/sslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/sslCertificates + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionSslCertificates + title: regionSslCertificates + regionTargetHttpProxies: + id: google.compute.regionTargetHttpProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies + response: + mediaType: application/json + openAPIDocKey: '200' + setUrlMap: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionTargetHttpProxies + title: regionTargetHttpProxies + regionTargetHttpsProxies: + id: google.compute.regionTargetHttpsProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies + response: + mediaType: application/json + openAPIDocKey: '200' + setSslCertificates: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setUrlMap: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionTargetHttpsProxies + title: regionTargetHttpsProxies + regionUrlMaps: + id: google.compute.regionUrlMaps + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/urlMaps + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/urlMaps + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + validate: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/urlMaps/{urlMap}/validate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: regionUrlMaps + title: regionUrlMaps + regions: + id: google.compute.regions + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions + response: + mediaType: application/json + openAPIDocKey: '200' + name: regions + title: regions + reservations: + id: google.compute.reservations + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/reservations + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/reservations/{reservation} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/reservations/{reservation} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/reservations + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/reservations + response: + mediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/reservations/{reservation}/resize + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: reservations + title: reservations + resourcePolicies: + id: google.compute.resourcePolicies + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/resourcePolicies + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: resourcePolicies + title: resourcePolicies + routers: + id: google.compute.routers + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/routers + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/routers/{router} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/routers/{router} + response: + mediaType: application/json + openAPIDocKey: '200' + getNatMappingInfo: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo + response: + mediaType: application/json + openAPIDocKey: '200' + getRouterStatus: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/routers/{router}/getRouterStatus + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/routers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/routers + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/routers/{router} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + preview: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/routers/{router}/preview + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/regions/{region}/routers/{router} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: routers + title: routers + routes: + id: google.compute.routes + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/routes/{route} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/routes/{route} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/routes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/routes + response: + mediaType: application/json + openAPIDocKey: '200' + name: routes + title: routes + securityPolicies: + id: google.compute.securityPolicies + methods: + addRule: + operation: + $ref: post + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy}/addRule + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + getRule: + operation: + $ref: get + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy}/getRule + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/securityPolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/securityPolicies + response: + mediaType: application/json + openAPIDocKey: '200' + listPreconfiguredExpressionSets: + operation: + $ref: get + path: + $ref: /projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patchRule: + operation: + $ref: post + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy}/patchRule + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removeRule: + operation: + $ref: post + path: + $ref: /projects/{project}/global/securityPolicies/{securityPolicy}/removeRule + response: + mediaType: application/json + openAPIDocKey: '200' + name: securityPolicies + title: securityPolicies + serviceAttachments: + id: google.compute.serviceAttachments + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/serviceAttachments + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: serviceAttachments + title: serviceAttachments + snapshots: + id: google.compute.snapshots + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/snapshots/{snapshot} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/snapshots/{snapshot} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/global/snapshots/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/snapshots + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/snapshots/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/global/snapshots/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/global/snapshots/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: snapshots + title: snapshots + sslCertificates: + id: google.compute.sslCertificates + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/sslCertificates + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/sslCertificates/{sslCertificate} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslCertificates/{sslCertificate} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/sslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslCertificates + response: + mediaType: application/json + openAPIDocKey: '200' + name: sslCertificates + title: sslCertificates + sslPolicies: + id: google.compute.sslPolicies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/sslPolicies/{sslPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslPolicies/{sslPolicy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/sslPolicies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslPolicies + response: + mediaType: application/json + openAPIDocKey: '200' + listAvailableFeatures: + operation: + $ref: get + path: + $ref: /projects/{project}/global/sslPolicies/listAvailableFeatures + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/sslPolicies/{sslPolicy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: sslPolicies + title: sslPolicies + subnetworks: + id: google.compute.subnetworks + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/subnetworks + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork} + response: + mediaType: application/json + openAPIDocKey: '200' + expandIpCidrRange: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/subnetworks + response: + mediaType: application/json + openAPIDocKey: '200' + listUsable: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/subnetworks/listUsable + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setPrivateIpGoogleAccess: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: subnetworks + title: subnetworks + targetGrpcProxies: + id: google.compute.targetGrpcProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetGrpcProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetGrpcProxies + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetGrpcProxies + title: targetGrpcProxies + targetHttpProxies: + id: google.compute.targetHttpProxies + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetHttpProxies + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetHttpProxies/{targetHttpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetHttpProxies/{targetHttpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetHttpProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetHttpProxies + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/targetHttpProxies/{targetHttpProxy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setUrlMap: + operation: + $ref: post + path: + $ref: /projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetHttpProxies + title: targetHttpProxies + targetHttpsProxies: + id: google.compute.targetHttpsProxies + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetHttpsProxies + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetHttpsProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetHttpsProxies + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setQuicOverride: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSslCertificates: + operation: + $ref: post + path: + $ref: /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSslPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setUrlMap: + operation: + $ref: post + path: + $ref: /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetHttpsProxies + title: targetHttpsProxies + targetInstances: + id: google.compute.targetInstances + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetInstances + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/targetInstances/{targetInstance} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/targetInstances/{targetInstance} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/targetInstances + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/targetInstances + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetInstances + title: targetInstances + targetPools: + id: google.compute.targetPools + methods: + addHealthCheck: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + addInstance: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetPools + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool} + response: + mediaType: application/json + openAPIDocKey: '200' + getHealth: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetPools + response: + mediaType: application/json + openAPIDocKey: '200' + removeHealthCheck: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + removeInstance: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setBackup: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetPools + title: targetPools + targetSslProxies: + id: google.compute.targetSslProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetSslProxies + response: + mediaType: application/json + openAPIDocKey: '200' + setBackendService: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setProxyHeader: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSslCertificates: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSslPolicy: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetSslProxies + title: targetSslProxies + targetTcpProxies: + id: google.compute.targetTcpProxies + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/targetTcpProxies/{targetTcpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetTcpProxies/{targetTcpProxy} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetTcpProxies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/targetTcpProxies + response: + mediaType: application/json + openAPIDocKey: '200' + setBackendService: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setProxyHeader: + operation: + $ref: post + path: + $ref: /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetTcpProxies + title: targetTcpProxies + targetVpnGateways: + id: google.compute.targetVpnGateways + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/targetVpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/targetVpnGateways + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/targetVpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + name: targetVpnGateways + title: targetVpnGateways + urlMaps: + id: google.compute.urlMaps + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/urlMaps + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/global/urlMaps/{urlMap} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/global/urlMaps/{urlMap} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/global/urlMaps + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + invalidateCache: + operation: + $ref: post + path: + $ref: /projects/{project}/global/urlMaps/{urlMap}/invalidateCache + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/global/urlMaps + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{project}/global/urlMaps/{urlMap} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{project}/global/urlMaps/{urlMap} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + validate: + operation: + $ref: post + path: + $ref: /projects/{project}/global/urlMaps/{urlMap}/validate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: urlMaps + title: urlMaps + vpnGateways: + id: google.compute.vpnGateways + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/vpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{vpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{vpnGateway} + response: + mediaType: application/json + openAPIDocKey: '200' + getStatus: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/vpnGateways + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnGateways + response: + mediaType: application/json + openAPIDocKey: '200' + setLabels: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: vpnGateways + title: vpnGateways + vpnTunnels: + id: google.compute.vpnTunnels + methods: + aggregatedList: + operation: + $ref: get + path: + $ref: /projects/{project}/aggregated/vpnTunnels + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{project}/regions/{region}/vpnTunnels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/regions/{region}/vpnTunnels + response: + mediaType: application/json + openAPIDocKey: '200' + name: vpnTunnels + title: vpnTunnels + zoneOperations: + id: google.compute.zoneOperations + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{project}/zones/{zone}/operations/{operation} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/operations/{operation} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone}/operations + response: + mediaType: application/json + openAPIDocKey: '200' + wait: + operation: + $ref: post + path: + $ref: /projects/{project}/zones/{zone}/operations/{operation}/wait + response: + mediaType: application/json + openAPIDocKey: '200' + name: zoneOperations + title: zoneOperations + zones: + id: google.compute.zones + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{project}/zones/{zone} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{project}/zones + response: + mediaType: application/json + openAPIDocKey: '200' + name: zones + title: zones +externalDocs: + url: https://cloud.google.com/compute/ +info: + contact: + name: Google + url: https://google.com + x-twitter: youtube + description: 'Creates and runs virtual machines on Google Cloud Platform. ' + license: + name: Creative Commons Attribution 3.0 + url: http://creativecommons.org/licenses/by/3.0/ + termsOfService: https://developers.google.com/terms/ + title: Compute Engine API + version: v1 + x-apiClientRegistration: + url: https://console.developers.google.com + x-apisguru-categories: + - analytics + - media + x-logo: + url: https://api.apis.guru/v2/cache/logo/https_www.google.com_images_branding_googlelogo_2x_googlelogo_color_272x92dp.png + x-origin: + - converter: + url: https://github.com/mermade/oas-kit + version: 7.0.4 + format: google + url: https://www.googleapis.com/discovery/v1/apis/compute/v1/rest + version: v1 + x-preferred: true + x-providerName: googleapis.com + x-serviceName: compute +openapi: 3.0.0 +paths: + /locations/global/firewallPolicies: + get: + description: Lists all the policies that have been configured for the specified + folder or organization. + operationId: compute.firewallPolicies.list + parameters: + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Parent ID for this request. + in: query + name: parentId + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewallPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new policy in the specified project using the data included + in the request. + operationId: compute.firewallPolicies.insert + parameters: + - description: Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" + if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent + is an organization. + in: query + name: parentId + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/listAssociations: + get: + description: Lists associations of a specified target, i.e., organization or + folder. + operationId: compute.firewallPolicies.listAssociations + parameters: + - description: The target resource to list associations. It is an organization, + or a folder. + in: query + name: targetResource + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPoliciesListAssociationsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewallPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /locations/global/firewallPolicies/{firewallPolicy}: + delete: + description: Deletes the specified policy. + operationId: compute.firewallPolicies.delete + parameters: + - description: Name of the firewall policy to delete. + in: path + name: firewallPolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + get: + description: Returns the specified firewall policy. + operationId: compute.firewallPolicies.get + parameters: + - description: Name of the firewall policy to get. + in: path + name: firewallPolicy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewallPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified policy with the data included in the request. + operationId: compute.firewallPolicies.patch + parameters: + - description: Name of the firewall policy to update. + in: path + name: firewallPolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{firewallPolicy}/addAssociation: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Inserts an association for the specified firewall policy. + operationId: compute.firewallPolicies.addAssociation + parameters: + - description: Name of the firewall policy to update. + in: path + name: firewallPolicy + required: true + schema: + type: string + - description: Indicates whether or not to replace it if an association of the + attachment already exists. This is false by default, in which case an error + will be returned if an association already exists. + in: query + name: replaceExistingAssociation + schema: + type: boolean + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyAssociation' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{firewallPolicy}/addRule: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Inserts a rule into a firewall policy. + operationId: compute.firewallPolicies.addRule + parameters: + - description: Name of the firewall policy to update. + in: path + name: firewallPolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{firewallPolicy}/cloneRules: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Copies rules to the specified firewall policy. + operationId: compute.firewallPolicies.cloneRules + parameters: + - description: Name of the firewall policy to update. + in: path + name: firewallPolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + - description: The firewall policy from which to copy rules. + in: query + name: sourceFirewallPolicy + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{firewallPolicy}/getAssociation: + get: + description: Gets an association with the specified name. + operationId: compute.firewallPolicies.getAssociation + parameters: + - description: Name of the firewall policy to which the queried rule belongs. + in: path + name: firewallPolicy + required: true + schema: + type: string + - description: The name of the association to get from the firewall policy. + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyAssociation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewallPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /locations/global/firewallPolicies/{firewallPolicy}/getRule: + get: + description: Gets a rule of the specified priority. + operationId: compute.firewallPolicies.getRule + parameters: + - description: Name of the firewall policy to which the queried rule belongs. + in: path + name: firewallPolicy + required: true + schema: + type: string + - description: The priority of the rule to get from the firewall policy. + in: query + name: priority + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyRule' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewallPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /locations/global/firewallPolicies/{firewallPolicy}/move: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Moves the specified firewall policy. + operationId: compute.firewallPolicies.move + parameters: + - description: Name of the firewall policy to update. + in: path + name: firewallPolicy + required: true + schema: + type: string + - description: The new parent of the firewall policy. + in: query + name: parentId + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{firewallPolicy}/patchRule: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Patches a rule of the specified priority. + operationId: compute.firewallPolicies.patchRule + parameters: + - description: Name of the firewall policy to update. + in: path + name: firewallPolicy + required: true + schema: + type: string + - description: The priority of the rule to patch. + in: query + name: priority + schema: + type: integer + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{firewallPolicy}/removeAssociation: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes an association for the specified firewall policy. + operationId: compute.firewallPolicies.removeAssociation + parameters: + - description: Name of the firewall policy to update. + in: path + name: firewallPolicy + required: true + schema: + type: string + - description: Name for the attachment that will be removed. + in: query + name: name + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{firewallPolicy}/removeRule: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Deletes a rule of the specified priority. + operationId: compute.firewallPolicies.removeRule + parameters: + - description: Name of the firewall policy to update. + in: path + name: firewallPolicy + required: true + schema: + type: string + - description: The priority of the rule to remove from the firewall policy. + in: query + name: priority + schema: + type: integer + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.firewallPolicies.getIamPolicy + parameters: + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewallPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /locations/global/firewallPolicies/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.firewallPolicies.setIamPolicy + parameters: + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalOrganizationSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewallPolicies + /locations/global/firewallPolicies/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.firewallPolicies.testIamPermissions + parameters: + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewallPolicies + /locations/global/operations: + get: + description: Retrieves a list of Operation resources contained within the specified + organization. + operationId: compute.globalOrganizationOperations.list + parameters: + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Parent ID for this request. + in: query + name: parentId + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperationList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalOrganizationOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /locations/global/operations/{operation}: + delete: + description: Deletes the specified Operations resource. + operationId: compute.globalOrganizationOperations.delete + parameters: + - description: Name of the Operations resource to delete. + in: path + name: operation + required: true + schema: + type: string + - description: Parent ID for this request. + in: query + name: parentId + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalOrganizationOperations + get: + description: Retrieves the specified Operations resource. Gets a list of operations + by making a `list()` request. + operationId: compute.globalOrganizationOperations.get + parameters: + - description: Name of the Operations resource to return. + in: path + name: operation + required: true + schema: + type: string + - description: Parent ID for this request. + in: query + name: parentId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalOrganizationOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}: + get: + description: Returns the specified Project resource. + operationId: compute.projects.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/acceleratorTypes: + get: + description: Retrieves an aggregated list of accelerator types. + operationId: compute.acceleratorTypes.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AcceleratorTypeAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - acceleratorTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/addresses: + get: + description: Retrieves an aggregated list of addresses. + operationId: compute.addresses.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AddressAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - addresses + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/autoscalers: + get: + description: Retrieves an aggregated list of autoscalers. + operationId: compute.autoscalers.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AutoscalerAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - autoscalers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/backendServices: + get: + description: Retrieves the list of all BackendService resources, regional and + global, available to the specified project. + operationId: compute.backendServices.aggregatedList + parameters: + - description: Name of the project scoping this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendServiceAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - backendServices + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/commitments: + get: + description: Retrieves an aggregated list of commitments by region. + operationId: compute.regionCommitments.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CommitmentAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionCommitments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/diskTypes: + get: + description: Retrieves an aggregated list of disk types. + operationId: compute.diskTypes.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskTypeAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - diskTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/disks: + get: + description: Retrieves an aggregated list of persistent disks. + operationId: compute.disks.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/forwardingRules: + get: + description: Retrieves an aggregated list of forwarding rules. + operationId: compute.forwardingRules.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRuleAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - forwardingRules + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/healthChecks: + get: + description: Retrieves the list of all HealthCheck resources, regional and global, + available to the specified project. + operationId: compute.healthChecks.aggregatedList + parameters: + - description: Name of the project scoping this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthChecksAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - healthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/instanceGroupManagers: + get: + description: Retrieves the list of managed instance groups and groups them by + zone. + operationId: compute.instanceGroupManagers.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagerAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroupManagers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/instanceGroups: + get: + description: Retrieves the list of instance groups and sorts them by zone. + operationId: compute.instanceGroups.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/instances: + get: + description: Retrieves an aggregated list of all of the instances in your project + across all regions and zones. The performance of this method degrades when + a filter is specified on a project that has a very large number of instances. + operationId: compute.instances.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/interconnectAttachments: + get: + description: Retrieves an aggregated list of interconnect attachments. + operationId: compute.interconnectAttachments.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectAttachmentAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - interconnectAttachments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/machineTypes: + get: + description: Retrieves an aggregated list of machine types. + operationId: compute.machineTypes.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineTypeAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - machineTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/networkEndpointGroups: + get: + description: Retrieves the list of network endpoint groups and sorts them by + zone. + operationId: compute.networkEndpointGroups.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networkEndpointGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/nodeGroups: + get: + description: 'Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes + for more details about each group.' + operationId: compute.nodeGroups.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/nodeTemplates: + get: + description: Retrieves an aggregated list of node templates. + operationId: compute.nodeTemplates.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTemplateAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeTemplates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/nodeTypes: + get: + description: Retrieves an aggregated list of node types. + operationId: compute.nodeTypes.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTypeAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/operations: + get: + description: Retrieves an aggregated list of all operations. + operationId: compute.globalOperations.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/packetMirrorings: + get: + description: Retrieves an aggregated list of packetMirrorings. + operationId: compute.packetMirrorings.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PacketMirroringAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - packetMirrorings + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/publicDelegatedPrefixes: + get: + description: Lists all PublicDelegatedPrefix resources owned by the specific + project across all scopes. + operationId: compute.publicDelegatedPrefixes.aggregatedList + parameters: + - description: Name of the project scoping this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefixAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - publicDelegatedPrefixes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/reservations: + get: + description: Retrieves an aggregated list of reservations. + operationId: compute.reservations.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ReservationAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - reservations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/resourcePolicies: + get: + description: Retrieves an aggregated list of resource policies. + operationId: compute.resourcePolicies.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourcePolicyAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - resourcePolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/routers: + get: + description: Retrieves an aggregated list of routers. + operationId: compute.routers.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RouterAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - routers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/serviceAttachments: + get: + description: Retrieves the list of all ServiceAttachment resources, regional + and global, available to the specified project. + operationId: compute.serviceAttachments.aggregatedList + parameters: + - description: Name of the project scoping this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAttachmentAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - serviceAttachments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/sslCertificates: + get: + description: Retrieves the list of all SslCertificate resources, regional and + global, available to the specified project. + operationId: compute.sslCertificates.aggregatedList + parameters: + - description: Name of the project scoping this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SslCertificateAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - sslCertificates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/subnetworks: + get: + description: Retrieves an aggregated list of subnetworks. + operationId: compute.subnetworks.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SubnetworkAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - subnetworks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/subnetworks/listUsable: + get: + description: Retrieves an aggregated list of all usable subnetworks in the project. + operationId: compute.subnetworks.listUsable + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UsableSubnetworksAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - subnetworks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/targetHttpProxies: + get: + description: Retrieves the list of all TargetHttpProxy resources, regional and + global, available to the specified project. + operationId: compute.targetHttpProxies.aggregatedList + parameters: + - description: Name of the project scoping this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpProxyAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetHttpProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/targetHttpsProxies: + get: + description: Retrieves the list of all TargetHttpsProxy resources, regional + and global, available to the specified project. + operationId: compute.targetHttpsProxies.aggregatedList + parameters: + - description: Name of the project scoping this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxyAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetHttpsProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/targetInstances: + get: + description: Retrieves an aggregated list of target instances. + operationId: compute.targetInstances.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetInstanceAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetInstances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/targetPools: + get: + description: Retrieves an aggregated list of target pools. + operationId: compute.targetPools.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPoolAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetPools + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/targetVpnGateways: + get: + description: Retrieves an aggregated list of target VPN gateways. + operationId: compute.targetVpnGateways.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetVpnGatewayAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetVpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/urlMaps: + get: + description: Retrieves the list of all UrlMap resources, regional and global, + available to the specified project. + operationId: compute.urlMaps.aggregatedList + parameters: + - description: Name of the project scoping this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapsAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - urlMaps + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/vpnGateways: + get: + description: Retrieves an aggregated list of VPN gateways. + operationId: compute.vpnGateways.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VpnGatewayAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - vpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/aggregated/vpnTunnels: + get: + description: Retrieves an aggregated list of VPN tunnels. + operationId: compute.vpnTunnels.aggregatedList + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - description: Indicates whether every visible scope for each scope type (zone, + region, global) should be included in the response. For new resource types + added after this field, the flag has no effect as new resource types will + always include every visible scope for each scope type in response. For + resource types which predate this field, if this flag is omitted or false, + only scopes of the scope types where the resource type is expected to be + found will be included. + in: query + name: includeAllScopes + schema: + type: boolean + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VpnTunnelAggregatedList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - vpnTunnels + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/disableXpnHost: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Disable this project as a shared VPC host project. + operationId: compute.projects.disableXpnHost + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/disableXpnResource: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Disable a service resource (also known as service project) associated + with this host project. + operationId: compute.projects.disableXpnResource + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsDisableXpnResourceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/enableXpnHost: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Enable this project as a shared VPC host project. + operationId: compute.projects.enableXpnHost + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/enableXpnResource: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Enable service resource (a.k.a service project) for a host project, + so that subnets in the host project can be used by instances in the service + project. + operationId: compute.projects.enableXpnResource + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsEnableXpnResourceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/getXpnHost: + get: + description: Gets the shared VPC host project that this project links to. May + be empty if no link exists. + operationId: compute.projects.getXpnHost + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/getXpnResources: + get: + description: Gets service resources (a.k.a service project) associated with + this host project. + operationId: compute.projects.getXpnResources + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsGetXpnResources' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/addresses: + get: + description: Retrieves a list of global addresses. + operationId: compute.globalAddresses.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AddressList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalAddresses + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates an address resource in the specified project by using the + data included in the request. + operationId: compute.globalAddresses.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalAddresses + /projects/{project}/global/addresses/{address}: + delete: + description: Deletes the specified address resource. + operationId: compute.globalAddresses.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the address resource to delete. + in: path + name: address + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalAddresses + get: + description: Returns the specified address resource. Gets a list of available + addresses by making a list() request. + operationId: compute.globalAddresses.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the address resource to return. + in: path + name: address + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalAddresses + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/backendBuckets: + get: + description: Retrieves the list of BackendBucket resources available to the + specified project. + operationId: compute.backendBuckets.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendBucketList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - backendBuckets + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a BackendBucket resource in the specified project using + the data included in the request. + operationId: compute.backendBuckets.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendBucket' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendBuckets + /projects/{project}/global/backendBuckets/{backendBucket}: + delete: + description: Deletes the specified BackendBucket resource. + operationId: compute.backendBuckets.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendBucket resource to delete. + in: path + name: backendBucket + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendBuckets + get: + description: Returns the specified BackendBucket resource. Gets a list of available + backend buckets by making a list() request. + operationId: compute.backendBuckets.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendBucket resource to return. + in: path + name: backendBucket + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendBucket' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - backendBuckets + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified BackendBucket resource with the data included + in the request. This method supports PATCH semantics and uses the JSON merge + patch format and processing rules. + operationId: compute.backendBuckets.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendBucket resource to patch. + in: path + name: backendBucket + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendBucket' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendBuckets + put: + description: Updates the specified BackendBucket resource with the data included + in the request. + operationId: compute.backendBuckets.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendBucket resource to update. + in: path + name: backendBucket + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendBucket' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendBuckets + /projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds a key for validating requests with signed URLs for this backend + bucket. + operationId: compute.backendBuckets.addSignedUrlKey + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendBucket resource to which the Signed URL Key + should be added. The name should conform to RFC1035. + in: path + name: backendBucket + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignedUrlKey' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendBuckets + /projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Deletes a key for validating requests with signed URLs for this + backend bucket. + operationId: compute.backendBuckets.deleteSignedUrlKey + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendBucket resource to which the Signed URL Key + should be added. The name should conform to RFC1035. + in: path + name: backendBucket + required: true + schema: + type: string + - description: The name of the Signed URL Key to delete. + in: query + name: keyName + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendBuckets + /projects/{project}/global/backendServices: + get: + description: Retrieves the list of BackendService resources available to the + specified project. + operationId: compute.backendServices.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendServiceList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - backendServices + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a BackendService resource in the specified project using + the data included in the request. For more information, see Backend services + overview . + operationId: compute.backendServices.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendServices + /projects/{project}/global/backendServices/{backendService}: + delete: + description: Deletes the specified BackendService resource. + operationId: compute.backendServices.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendService resource to delete. + in: path + name: backendService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendServices + get: + description: Returns the specified BackendService resource. Gets a list of available + backend services. + operationId: compute.backendServices.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendService resource to return. + in: path + name: backendService + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - backendServices + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified BackendService resource with the data included + in the request. For more information, see Backend services overview. This + method supports PATCH semantics and uses the JSON merge patch format and processing + rules. + operationId: compute.backendServices.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendService resource to patch. + in: path + name: backendService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendServices + put: + description: Updates the specified BackendService resource with the data included + in the request. For more information, see Backend services overview. + operationId: compute.backendServices.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendService resource to update. + in: path + name: backendService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendServices + /projects/{project}/global/backendServices/{backendService}/addSignedUrlKey: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds a key for validating requests with signed URLs for this backend + service. + operationId: compute.backendServices.addSignedUrlKey + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendService resource to which the Signed URL Key + should be added. The name should conform to RFC1035. + in: path + name: backendService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignedUrlKey' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendServices + /projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Deletes a key for validating requests with signed URLs for this + backend service. + operationId: compute.backendServices.deleteSignedUrlKey + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendService resource to which the Signed URL Key + should be added. The name should conform to RFC1035. + in: path + name: backendService + required: true + schema: + type: string + - description: The name of the Signed URL Key to delete. + in: query + name: keyName + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendServices + /projects/{project}/global/backendServices/{backendService}/getHealth: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Gets the most recent health check results for this BackendService. + Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" + }' + operationId: compute.backendServices.getHealth + parameters: + - in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendService resource to which the queried instance + belongs. + in: path + name: backendService + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceGroupReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendServiceGroupHealth' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - backendServices + /projects/{project}/global/backendServices/{backendService}/setSecurityPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the Google Cloud Armor security policy for the specified backend + service. For more information, see Google Cloud Armor Overview + operationId: compute.backendServices.setSecurityPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the BackendService resource to which the security policy + should be set. The name should conform to RFC1035. + in: path + name: backendService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicyReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - backendServices + /projects/{project}/global/externalVpnGateways: + get: + description: Retrieves the list of ExternalVpnGateway available to the specified + project. + operationId: compute.externalVpnGateways.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalVpnGatewayList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - externalVpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a ExternalVpnGateway in the specified project using the + data included in the request. + operationId: compute.externalVpnGateways.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalVpnGateway' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - externalVpnGateways + /projects/{project}/global/externalVpnGateways/{externalVpnGateway}: + delete: + description: Deletes the specified externalVpnGateway. + operationId: compute.externalVpnGateways.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the externalVpnGateways to delete. + in: path + name: externalVpnGateway + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - externalVpnGateways + get: + description: Returns the specified externalVpnGateway. Get a list of available + externalVpnGateways by making a list() request. + operationId: compute.externalVpnGateways.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the externalVpnGateway to return. + in: path + name: externalVpnGateway + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalVpnGateway' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - externalVpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/externalVpnGateways/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on an ExternalVpnGateway. To learn more about labels, + read the Labeling Resources documentation. + operationId: compute.externalVpnGateways.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - externalVpnGateways + /projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.externalVpnGateways.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - externalVpnGateways + /projects/{project}/global/firewalls: + get: + description: Retrieves the list of firewall rules available to the specified + project. + operationId: compute.firewalls.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewalls + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a firewall rule in the specified project using the data + included in the request. + operationId: compute.firewalls.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Firewall' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewalls + /projects/{project}/global/firewalls/{firewall}: + delete: + description: Deletes the specified firewall. + operationId: compute.firewalls.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the firewall rule to delete. + in: path + name: firewall + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewalls + get: + description: Returns the specified firewall. + operationId: compute.firewalls.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the firewall rule to return. + in: path + name: firewall + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Firewall' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - firewalls + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified firewall rule with the data included in the + request. This method supports PATCH semantics and uses the JSON merge patch + format and processing rules. + operationId: compute.firewalls.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the firewall rule to patch. + in: path + name: firewall + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Firewall' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewalls + put: + description: Updates the specified firewall rule with the data included in the + request. Note that all fields will be updated if using PUT, even fields that + are not specified. To update individual fields, please use PATCH instead. + operationId: compute.firewalls.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the firewall rule to update. + in: path + name: firewall + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Firewall' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - firewalls + /projects/{project}/global/forwardingRules: + get: + description: Retrieves a list of GlobalForwardingRule resources available to + the specified project. + operationId: compute.globalForwardingRules.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRuleList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalForwardingRules + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a GlobalForwardingRule resource in the specified project + using the data included in the request. + operationId: compute.globalForwardingRules.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalForwardingRules + /projects/{project}/global/forwardingRules/{forwardingRule}: + delete: + description: Deletes the specified GlobalForwardingRule resource. + operationId: compute.globalForwardingRules.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the ForwardingRule resource to delete. + in: path + name: forwardingRule + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalForwardingRules + get: + description: Returns the specified GlobalForwardingRule resource. Gets a list + of available forwarding rules by making a list() request. + operationId: compute.globalForwardingRules.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the ForwardingRule resource to return. + in: path + name: forwardingRule + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRule' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalForwardingRules + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified forwarding rule with the data included in + the request. This method supports PATCH semantics and uses the JSON merge + patch format and processing rules. Currently, you can only patch the network_tier + field. + operationId: compute.globalForwardingRules.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the ForwardingRule resource to patch. + in: path + name: forwardingRule + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalForwardingRules + /projects/{project}/global/forwardingRules/{forwardingRule}/setTarget: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes target URL for the GlobalForwardingRule resource. The new + target should be of the same type as the old target. + operationId: compute.globalForwardingRules.setTarget + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the ForwardingRule resource in which target is to be + set. + in: path + name: forwardingRule + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalForwardingRules + /projects/{project}/global/forwardingRules/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on the specified resource. To learn more about + labels, read the Labeling resources documentation. + operationId: compute.globalForwardingRules.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalForwardingRules + /projects/{project}/global/healthChecks: + get: + description: Retrieves the list of HealthCheck resources available to the specified + project. + operationId: compute.healthChecks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheckList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - healthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a HealthCheck resource in the specified project using the + data included in the request. + operationId: compute.healthChecks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - healthChecks + /projects/{project}/global/healthChecks/{healthCheck}: + delete: + description: Deletes the specified HealthCheck resource. + operationId: compute.healthChecks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HealthCheck resource to delete. + in: path + name: healthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - healthChecks + get: + description: Returns the specified HealthCheck resource. Gets a list of available + health checks by making a list() request. + operationId: compute.healthChecks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HealthCheck resource to return. + in: path + name: healthCheck + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - healthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates a HealthCheck resource in the specified project using the + data included in the request. This method supports PATCH semantics and uses + the JSON merge patch format and processing rules. + operationId: compute.healthChecks.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HealthCheck resource to patch. + in: path + name: healthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - healthChecks + put: + description: Updates a HealthCheck resource in the specified project using the + data included in the request. + operationId: compute.healthChecks.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HealthCheck resource to update. + in: path + name: healthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - healthChecks + /projects/{project}/global/httpHealthChecks: + get: + description: Retrieves the list of HttpHealthCheck resources available to the + specified project. + operationId: compute.httpHealthChecks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HttpHealthCheckList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - httpHealthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a HttpHealthCheck resource in the specified project using + the data included in the request. + operationId: compute.httpHealthChecks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpHealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - httpHealthChecks + /projects/{project}/global/httpHealthChecks/{httpHealthCheck}: + delete: + description: Deletes the specified HttpHealthCheck resource. + operationId: compute.httpHealthChecks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HttpHealthCheck resource to delete. + in: path + name: httpHealthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - httpHealthChecks + get: + description: Returns the specified HttpHealthCheck resource. Gets a list of + available HTTP health checks by making a list() request. + operationId: compute.httpHealthChecks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HttpHealthCheck resource to return. + in: path + name: httpHealthCheck + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HttpHealthCheck' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - httpHealthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates a HttpHealthCheck resource in the specified project using + the data included in the request. This method supports PATCH semantics and + uses the JSON merge patch format and processing rules. + operationId: compute.httpHealthChecks.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HttpHealthCheck resource to patch. + in: path + name: httpHealthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpHealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - httpHealthChecks + put: + description: Updates a HttpHealthCheck resource in the specified project using + the data included in the request. + operationId: compute.httpHealthChecks.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HttpHealthCheck resource to update. + in: path + name: httpHealthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpHealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - httpHealthChecks + /projects/{project}/global/httpsHealthChecks: + get: + description: Retrieves the list of HttpsHealthCheck resources available to the + specified project. + operationId: compute.httpsHealthChecks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HttpsHealthCheckList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - httpsHealthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a HttpsHealthCheck resource in the specified project using + the data included in the request. + operationId: compute.httpsHealthChecks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpsHealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - httpsHealthChecks + /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}: + delete: + description: Deletes the specified HttpsHealthCheck resource. + operationId: compute.httpsHealthChecks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HttpsHealthCheck resource to delete. + in: path + name: httpsHealthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - httpsHealthChecks + get: + description: Returns the specified HttpsHealthCheck resource. Gets a list of + available HTTPS health checks by making a list() request. + operationId: compute.httpsHealthChecks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HttpsHealthCheck resource to return. + in: path + name: httpsHealthCheck + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HttpsHealthCheck' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - httpsHealthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates a HttpsHealthCheck resource in the specified project using + the data included in the request. This method supports PATCH semantics and + uses the JSON merge patch format and processing rules. + operationId: compute.httpsHealthChecks.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HttpsHealthCheck resource to patch. + in: path + name: httpsHealthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpsHealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - httpsHealthChecks + put: + description: Updates a HttpsHealthCheck resource in the specified project using + the data included in the request. + operationId: compute.httpsHealthChecks.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the HttpsHealthCheck resource to update. + in: path + name: httpsHealthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpsHealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - httpsHealthChecks + /projects/{project}/global/images: + get: + description: Retrieves the list of custom images available to the specified + project. Custom images are images you create that belong to your project. + This method does not get any images that belong to other projects, including + publicly-available images, like Debian 8. If you want to get a list of publicly-available + images, use this method to make a request to the respective image project, + such as debian-cloud or windows-cloud. + operationId: compute.images.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ImageList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - images + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates an image in the specified project using the data included + in the request. + operationId: compute.images.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Force image creation if true. + in: query + name: forceCreate + schema: + type: boolean + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - images + /projects/{project}/global/images/family/{family}: + get: + description: Returns the latest image that is part of an image family and is + not deprecated. + operationId: compute.images.getFromFamily + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the image family to search for. + in: path + name: family + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - images + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/images/{image}: + delete: + description: Deletes the specified image. + operationId: compute.images.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the image resource to delete. + in: path + name: image + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - images + get: + description: Returns the specified image. Gets a list of available images by + making a list() request. + operationId: compute.images.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the image resource to return. + in: path + name: image + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - images + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: 'Patches the specified image with the data included in the request. + Only the following fields can be modified: family, description, deprecation + status.' + operationId: compute.images.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the image resource to patch. + in: path + name: image + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - images + /projects/{project}/global/images/{image}/deprecate: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the deprecation status of an image. If an empty request body + is given, clears the deprecation status instead. + operationId: compute.images.deprecate + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Image name. + in: path + name: image + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeprecationStatus' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - images + /projects/{project}/global/images/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.images.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - images + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/images/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.images.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - images + /projects/{project}/global/images/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on an image. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.images.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - images + /projects/{project}/global/images/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.images.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - images + /projects/{project}/global/instanceTemplates: + get: + description: Retrieves a list of instance templates that are contained within + the specified project. + operationId: compute.instanceTemplates.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceTemplateList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceTemplates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates an instance template in the specified project using the + data that is included in the request. If you are creating a new template to + update an existing instance group, your new instance template must use the + same network or, if applicable, the same subnetwork as the original template. + operationId: compute.instanceTemplates.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceTemplate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceTemplates + /projects/{project}/global/instanceTemplates/{instanceTemplate}: + delete: + description: Deletes the specified instance template. Deleting an instance template + is permanent and cannot be undone. It is not possible to delete templates + that are already in use by a managed instance group. + operationId: compute.instanceTemplates.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the instance template to delete. + in: path + name: instanceTemplate + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceTemplates + get: + description: Returns the specified instance template. Gets a list of available + instance templates by making a list() request. + operationId: compute.instanceTemplates.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the instance template. + in: path + name: instanceTemplate + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceTemplate' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceTemplates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/instanceTemplates/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.instanceTemplates.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceTemplates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/instanceTemplates/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.instanceTemplates.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceTemplates + /projects/{project}/global/instanceTemplates/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.instanceTemplates.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceTemplates + /projects/{project}/global/interconnectLocations: + get: + description: Retrieves the list of interconnect locations available to the specified + project. + operationId: compute.interconnectLocations.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectLocationList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - interconnectLocations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/interconnectLocations/{interconnectLocation}: + get: + description: Returns the details for the specified interconnect location. Gets + a list of available interconnect locations by making a list() request. + operationId: compute.interconnectLocations.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the interconnect location to return. + in: path + name: interconnectLocation + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectLocation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - interconnectLocations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/interconnects: + get: + description: Retrieves the list of interconnect available to the specified project. + operationId: compute.interconnects.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - interconnects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a Interconnect in the specified project using the data + included in the request. + operationId: compute.interconnects.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Interconnect' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - interconnects + /projects/{project}/global/interconnects/{interconnect}: + delete: + description: Deletes the specified interconnect. + operationId: compute.interconnects.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the interconnect to delete. + in: path + name: interconnect + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - interconnects + get: + description: Returns the specified interconnect. Get a list of available interconnects + by making a list() request. + operationId: compute.interconnects.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the interconnect to return. + in: path + name: interconnect + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Interconnect' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - interconnects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified interconnect with the data included in the + request. This method supports PATCH semantics and uses the JSON merge patch + format and processing rules. + operationId: compute.interconnects.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the interconnect to update. + in: path + name: interconnect + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Interconnect' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - interconnects + /projects/{project}/global/interconnects/{interconnect}/getDiagnostics: + get: + description: Returns the interconnectDiagnostics for the specified interconnect. + operationId: compute.interconnects.getDiagnostics + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the interconnect resource to query. + in: path + name: interconnect + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectsGetDiagnosticsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - interconnects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/licenseCodes/{licenseCode}: + get: + description: 'Return a specified license code. License codes are mirrored across + all projects that have permissions to read the License Code. *Caution* This + resource is intended for use only by third-party partners who are creating + Cloud Marketplace images. ' + operationId: compute.licenseCodes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Number corresponding to the License code resource to return. + in: path + name: licenseCode + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseCode' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - licenseCodes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/licenseCodes/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Returns permissions that a caller has on the specified resource. + *Caution* This resource is intended for use only by third-party partners who + are creating Cloud Marketplace images. ' + operationId: compute.licenseCodes.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - licenseCodes + /projects/{project}/global/licenses: + get: + description: 'Retrieves the list of licenses available in the specified project. + This method does not get any licenses that belong to other projects, including + licenses attached to publicly-available images, like Debian 9. If you want + to get a list of publicly-available licenses, use this method to make a request + to the respective image project, such as debian-cloud or windows-cloud. *Caution* + This resource is intended for use only by third-party partners who are creating + Cloud Marketplace images. ' + operationId: compute.licenses.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LicensesListResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - licenses + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Create a License resource in the specified project. *Caution* + This resource is intended for use only by third-party partners who are creating + Cloud Marketplace images. ' + operationId: compute.licenses.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/License' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - licenses + /projects/{project}/global/licenses/{license}: + delete: + description: 'Deletes the specified license. *Caution* This resource is intended + for use only by third-party partners who are creating Cloud Marketplace images. ' + operationId: compute.licenses.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the license resource to delete. + in: path + name: license + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - licenses + get: + description: 'Returns the specified License resource. *Caution* This resource + is intended for use only by third-party partners who are creating Cloud Marketplace + images. ' + operationId: compute.licenses.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the License resource to return. + in: path + name: license + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/License' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - licenses + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/licenses/{resource}/getIamPolicy: + get: + description: 'Gets the access control policy for a resource. May be empty if + no such policy or resource exists. *Caution* This resource is intended for + use only by third-party partners who are creating Cloud Marketplace images. ' + operationId: compute.licenses.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - licenses + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/licenses/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Sets the access control policy on the specified resource. Replaces + any existing policy. *Caution* This resource is intended for use only by third-party + partners who are creating Cloud Marketplace images. ' + operationId: compute.licenses.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - licenses + /projects/{project}/global/licenses/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Returns permissions that a caller has on the specified resource. + *Caution* This resource is intended for use only by third-party partners who + are creating Cloud Marketplace images. ' + operationId: compute.licenses.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - licenses + /projects/{project}/global/networkEndpointGroups: + get: + description: Retrieves the list of network endpoint groups that are located + in the specified project. + operationId: compute.globalNetworkEndpointGroups.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalNetworkEndpointGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a network endpoint group in the specified project using + the parameters that are included in the request. + operationId: compute.globalNetworkEndpointGroups.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalNetworkEndpointGroups + /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}: + delete: + description: Deletes the specified network endpoint group.Note that the NEG + cannot be deleted if there are backend services referencing it. + operationId: compute.globalNetworkEndpointGroups.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the network endpoint group to delete. It should comply + with RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalNetworkEndpointGroups + get: + description: Returns the specified network endpoint group. Gets a list of available + network endpoint groups by making a list() request. + operationId: compute.globalNetworkEndpointGroups.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the network endpoint group. It should comply with + RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroup' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalNetworkEndpointGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Attach a network endpoint to the specified network endpoint group. + operationId: compute.globalNetworkEndpointGroups.attachNetworkEndpoints + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the network endpoint group where you are attaching + network endpoints to. It should comply with RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalNetworkEndpointGroupsAttachEndpointsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalNetworkEndpointGroups + /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Detach the network endpoint from the specified network endpoint + group. + operationId: compute.globalNetworkEndpointGroups.detachNetworkEndpoints + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the network endpoint group where you are removing + network endpoints. It should comply with RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalNetworkEndpointGroupsDetachEndpointsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalNetworkEndpointGroups + /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists the network endpoints in the specified network endpoint group. + operationId: compute.globalNetworkEndpointGroups.listNetworkEndpoints + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupsListNetworkEndpoints' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalNetworkEndpointGroups + /projects/{project}/global/networks: + get: + description: Retrieves the list of networks available to the specified project. + operationId: compute.networks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a network in the specified project using the data included + in the request. + operationId: compute.networks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Network' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networks + /projects/{project}/global/networks/{network}: + delete: + description: Deletes the specified network. + operationId: compute.networks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network to delete. + in: path + name: network + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networks + get: + description: Returns the specified network. Gets a list of available networks + by making a list() request. + operationId: compute.networks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network to return. + in: path + name: network + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Network' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: 'Patches the specified network with the data included in the request. + Only the following fields can be modified: routingConfig.routingMode.' + operationId: compute.networks.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network to update. + in: path + name: network + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Network' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networks + /projects/{project}/global/networks/{network}/addPeering: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds a peering to the specified network. + operationId: compute.networks.addPeering + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network resource to add peering to. + in: path + name: network + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworksAddPeeringRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networks + /projects/{project}/global/networks/{network}/getEffectiveFirewalls: + get: + description: Returns the effective firewalls on a given network. + operationId: compute.networks.getEffectiveFirewalls + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network for this request. + in: path + name: network + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworksGetEffectiveFirewallsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/networks/{network}/listPeeringRoutes: + get: + description: Lists the peering routes exchanged over peering connection. + operationId: compute.networks.listPeeringRoutes + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network for this request. + in: path + name: network + required: true + schema: + type: string + - description: The direction of the exchanged routes. + in: query + name: direction + schema: + enum: + - INCOMING + - OUTGOING + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: The response will show routes exchanged over the given peering + connection. + in: query + name: peeringName + schema: + type: string + - description: The region of the request. The response will include all subnet + routes, static routes and dynamic routes in the region. + in: query + name: region + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExchangedPeeringRoutesList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/networks/{network}/removePeering: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes a peering from the specified network. + operationId: compute.networks.removePeering + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network resource to remove peering from. + in: path + name: network + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworksRemovePeeringRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networks + /projects/{project}/global/networks/{network}/switchToCustomMode: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Switches the network mode from auto subnet mode to custom subnet + mode. + operationId: compute.networks.switchToCustomMode + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network to be updated. + in: path + name: network + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networks + /projects/{project}/global/networks/{network}/updatePeering: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified network peering with the data included in + the request. You can only modify the NetworkPeering.export_custom_routes field + and the NetworkPeering.import_custom_routes field. + operationId: compute.networks.updatePeering + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the network resource which the updated peering is belonging + to. + in: path + name: network + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworksUpdatePeeringRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networks + /projects/{project}/global/operations: + get: + description: Retrieves a list of Operation resources contained within the specified + project. + operationId: compute.globalOperations.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperationList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/operations/{operation}: + delete: + description: Deletes the specified Operations resource. + operationId: compute.globalOperations.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the Operations resource to delete. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalOperations + get: + description: Retrieves the specified Operations resource. + operationId: compute.globalOperations.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the Operations resource to return. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/operations/{operation}/wait: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Waits for the specified Operation resource to return as `DONE` + or for the request to approach the 2 minute deadline, and retrieves the specified + Operation resource. This method differs from the `GET` method in that it waits + for no more than the default deadline (2 minutes) and then returns the current + state of the operation, which might be `DONE` or still in progress. This method + is called on a best-effort basis. Specifically: - In uncommon cases, when + the server is overloaded, the request might return before the default deadline + is reached, or might return after zero seconds. - If the default deadline + is reached, there is no guarantee that the operation is actually done when + the method returns. Be prepared to retry if the operation is not `DONE`. ' + operationId: compute.globalOperations.wait + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the Operations resource to return. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalOperations + /projects/{project}/global/publicAdvertisedPrefixes: + get: + description: Lists the PublicAdvertisedPrefixes for a project. + operationId: compute.publicAdvertisedPrefixes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PublicAdvertisedPrefixList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - publicAdvertisedPrefixes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a PublicAdvertisedPrefix in the specified project using + the parameters that are included in the request. + operationId: compute.publicAdvertisedPrefixes.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicAdvertisedPrefix' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - publicAdvertisedPrefixes + /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}: + delete: + description: Deletes the specified PublicAdvertisedPrefix + operationId: compute.publicAdvertisedPrefixes.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the PublicAdvertisedPrefix resource to delete. + in: path + name: publicAdvertisedPrefix + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - publicAdvertisedPrefixes + get: + description: Returns the specified PublicAdvertisedPrefix resource. + operationId: compute.publicAdvertisedPrefixes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the PublicAdvertisedPrefix resource to return. + in: path + name: publicAdvertisedPrefix + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PublicAdvertisedPrefix' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - publicAdvertisedPrefixes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified Router resource with the data included in + the request. This method supports PATCH semantics and uses JSON merge patch + format and processing rules. + operationId: compute.publicAdvertisedPrefixes.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the PublicAdvertisedPrefix resource to patch. + in: path + name: publicAdvertisedPrefix + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicAdvertisedPrefix' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - publicAdvertisedPrefixes + /projects/{project}/global/publicDelegatedPrefixes: + get: + description: Lists the global PublicDelegatedPrefixes for a project. + operationId: compute.globalPublicDelegatedPrefixes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefixList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalPublicDelegatedPrefixes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a global PublicDelegatedPrefix in the specified project + using the parameters that are included in the request. + operationId: compute.globalPublicDelegatedPrefixes.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefix' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalPublicDelegatedPrefixes + /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}: + delete: + description: Deletes the specified global PublicDelegatedPrefix. + operationId: compute.globalPublicDelegatedPrefixes.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the PublicDelegatedPrefix resource to delete. + in: path + name: publicDelegatedPrefix + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalPublicDelegatedPrefixes + get: + description: Returns the specified global PublicDelegatedPrefix resource. + operationId: compute.globalPublicDelegatedPrefixes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the PublicDelegatedPrefix resource to return. + in: path + name: publicDelegatedPrefix + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefix' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - globalPublicDelegatedPrefixes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified global PublicDelegatedPrefix resource with + the data included in the request. This method supports PATCH semantics and + uses JSON merge patch format and processing rules. + operationId: compute.globalPublicDelegatedPrefixes.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the PublicDelegatedPrefix resource to patch. + in: path + name: publicDelegatedPrefix + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefix' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - globalPublicDelegatedPrefixes + /projects/{project}/global/routes: + get: + description: Retrieves the list of Route resources available to the specified + project. + operationId: compute.routes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RouteList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - routes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a Route resource in the specified project using the data + included in the request. + operationId: compute.routes.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Route' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - routes + /projects/{project}/global/routes/{route}: + delete: + description: Deletes the specified Route resource. + operationId: compute.routes.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the Route resource to delete. + in: path + name: route + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - routes + get: + description: Returns the specified Route resource. Gets a list of available + routes by making a list() request. + operationId: compute.routes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the Route resource to return. + in: path + name: route + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Route' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - routes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/securityPolicies: + get: + description: List all the policies that have been configured for the specified + project. + operationId: compute.securityPolicies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - securityPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new policy in the specified project using the data included + in the request. + operationId: compute.securityPolicies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - securityPolicies + /projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets: + get: + description: Gets the current list of preconfigured Web Application Firewall + (WAF) expressions. + operationId: compute.securityPolicies.listPreconfiguredExpressionSets + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPoliciesListPreconfiguredExpressionSetsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - securityPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/securityPolicies/{securityPolicy}: + delete: + description: Deletes the specified policy. + operationId: compute.securityPolicies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the security policy to delete. + in: path + name: securityPolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - securityPolicies + get: + description: List all of the ordered rules present in a single specified policy. + operationId: compute.securityPolicies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the security policy to get. + in: path + name: securityPolicy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - securityPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified policy with the data included in the request. + This cannot be used to be update the rules in the policy. Please use the per + rule methods like addRule, patchRule, and removeRule instead. + operationId: compute.securityPolicies.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the security policy to update. + in: path + name: securityPolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - securityPolicies + /projects/{project}/global/securityPolicies/{securityPolicy}/addRule: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Inserts a rule into a security policy. + operationId: compute.securityPolicies.addRule + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the security policy to update. + in: path + name: securityPolicy + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicyRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - securityPolicies + /projects/{project}/global/securityPolicies/{securityPolicy}/getRule: + get: + description: Gets a rule at the specified priority. + operationId: compute.securityPolicies.getRule + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the security policy to which the queried rule belongs. + in: path + name: securityPolicy + required: true + schema: + type: string + - description: The priority of the rule to get from the security policy. + in: query + name: priority + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicyRule' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - securityPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/securityPolicies/{securityPolicy}/patchRule: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Patches a rule at the specified priority. + operationId: compute.securityPolicies.patchRule + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the security policy to update. + in: path + name: securityPolicy + required: true + schema: + type: string + - description: The priority of the rule to patch. + in: query + name: priority + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicyRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - securityPolicies + /projects/{project}/global/securityPolicies/{securityPolicy}/removeRule: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Deletes a rule at the specified priority. + operationId: compute.securityPolicies.removeRule + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the security policy to update. + in: path + name: securityPolicy + required: true + schema: + type: string + - description: The priority of the rule to remove from the security policy. + in: query + name: priority + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - securityPolicies + /projects/{project}/global/snapshots: + get: + description: Retrieves the list of Snapshot resources contained within the specified + project. + operationId: compute.snapshots.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - snapshots + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/snapshots/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.snapshots.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - snapshots + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/snapshots/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.snapshots.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - snapshots + /projects/{project}/global/snapshots/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on a snapshot. To learn more about labels, read + the Labeling Resources documentation. + operationId: compute.snapshots.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - snapshots + /projects/{project}/global/snapshots/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.snapshots.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - snapshots + /projects/{project}/global/snapshots/{snapshot}: + delete: + description: Deletes the specified Snapshot resource. Keep in mind that deleting + a single snapshot might not necessarily delete all the data on that snapshot. + If any data on the snapshot that is marked for deletion is needed for subsequent + snapshots, the data will be moved to the next corresponding snapshot. For + more information, see Deleting snapshots. + operationId: compute.snapshots.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the Snapshot resource to delete. + in: path + name: snapshot + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - snapshots + get: + description: Returns the specified Snapshot resource. Gets a list of available + snapshots by making a list() request. + operationId: compute.snapshots.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the Snapshot resource to return. + in: path + name: snapshot + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - snapshots + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/sslCertificates: + get: + description: Retrieves the list of SslCertificate resources available to the + specified project. + operationId: compute.sslCertificates.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SslCertificateList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - sslCertificates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a SslCertificate resource in the specified project using + the data included in the request. + operationId: compute.sslCertificates.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslCertificate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - sslCertificates + /projects/{project}/global/sslCertificates/{sslCertificate}: + delete: + description: Deletes the specified SslCertificate resource. + operationId: compute.sslCertificates.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the SslCertificate resource to delete. + in: path + name: sslCertificate + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - sslCertificates + get: + description: Returns the specified SslCertificate resource. Gets a list of available + SSL certificates by making a list() request. + operationId: compute.sslCertificates.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the SslCertificate resource to return. + in: path + name: sslCertificate + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SslCertificate' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - sslCertificates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/sslPolicies: + get: + description: Lists all the SSL policies that have been configured for the specified + project. + operationId: compute.sslPolicies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SslPoliciesList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - sslPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns the specified SSL policy resource. Gets a list of available + SSL policies by making a list() request. + operationId: compute.sslPolicies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslPolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - sslPolicies + /projects/{project}/global/sslPolicies/listAvailableFeatures: + get: + description: Lists all features that can be specified in the SSL policy when + using custom profile. + operationId: compute.sslPolicies.listAvailableFeatures + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SslPoliciesListAvailableFeaturesResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - sslPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/sslPolicies/{sslPolicy}: + delete: + description: Deletes the specified SSL policy. The SSL policy resource can be + deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy + resources. + operationId: compute.sslPolicies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the SSL policy to delete. The name must be 1-63 characters + long, and comply with RFC1035. + in: path + name: sslPolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - sslPolicies + get: + description: Lists all of the ordered rules present in a single specified policy. + operationId: compute.sslPolicies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the SSL policy to update. The name must be 1-63 characters + long, and comply with RFC1035. + in: path + name: sslPolicy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SslPolicy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - sslPolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified SSL policy with the data included in the + request. + operationId: compute.sslPolicies.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the SSL policy to update. The name must be 1-63 characters + long, and comply with RFC1035. + in: path + name: sslPolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslPolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - sslPolicies + /projects/{project}/global/targetGrpcProxies: + get: + description: Lists the TargetGrpcProxies for a project in the given scope. + operationId: compute.targetGrpcProxies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetGrpcProxyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetGrpcProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a TargetGrpcProxy in the specified project in the given + scope using the parameters that are included in the request. + operationId: compute.targetGrpcProxies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetGrpcProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetGrpcProxies + /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}: + delete: + description: Deletes the specified TargetGrpcProxy in the given scope + operationId: compute.targetGrpcProxies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetGrpcProxy resource to delete. + in: path + name: targetGrpcProxy + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetGrpcProxies + get: + description: Returns the specified TargetGrpcProxy resource in the given scope. + operationId: compute.targetGrpcProxies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetGrpcProxy resource to return. + in: path + name: targetGrpcProxy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetGrpcProxy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetGrpcProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified TargetGrpcProxy resource with the data included + in the request. This method supports PATCH semantics and uses JSON merge patch + format and processing rules. + operationId: compute.targetGrpcProxies.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetGrpcProxy resource to patch. + in: path + name: targetGrpcProxy + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetGrpcProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetGrpcProxies + /projects/{project}/global/targetHttpProxies: + get: + description: Retrieves the list of TargetHttpProxy resources available to the + specified project. + operationId: compute.targetHttpProxies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpProxyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetHttpProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a TargetHttpProxy resource in the specified project using + the data included in the request. + operationId: compute.targetHttpProxies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpProxies + /projects/{project}/global/targetHttpProxies/{targetHttpProxy}: + delete: + description: Deletes the specified TargetHttpProxy resource. + operationId: compute.targetHttpProxies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpProxy resource to delete. + in: path + name: targetHttpProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpProxies + get: + description: Returns the specified TargetHttpProxy resource. Gets a list of + available target HTTP proxies by making a list() request. + operationId: compute.targetHttpProxies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpProxy resource to return. + in: path + name: targetHttpProxy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpProxy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetHttpProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified TargetHttpProxy resource with the data included + in the request. This method supports PATCH semantics and uses JSON merge patch + format and processing rules. + operationId: compute.targetHttpProxies.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpProxy resource to patch. + in: path + name: targetHttpProxy + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpProxies + /projects/{project}/global/targetHttpsProxies: + get: + description: Retrieves the list of TargetHttpsProxy resources available to the + specified project. + operationId: compute.targetHttpsProxies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetHttpsProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a TargetHttpsProxy resource in the specified project using + the data included in the request. + operationId: compute.targetHttpsProxies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpsProxies + /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}: + delete: + description: Deletes the specified TargetHttpsProxy resource. + operationId: compute.targetHttpsProxies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource to delete. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpsProxies + get: + description: Returns the specified TargetHttpsProxy resource. Gets a list of + available target HTTPS proxies by making a list() request. + operationId: compute.targetHttpsProxies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource to return. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetHttpsProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified TargetHttpsProxy resource with the data included + in the request. This method supports PATCH semantics and uses JSON merge patch + format and processing rules. + operationId: compute.targetHttpsProxies.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource to patch. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpsProxies + /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the QUIC override policy for TargetHttpsProxy. + operationId: compute.targetHttpsProxies.setQuicOverride + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource to set the QUIC override + policy for. The name should conform to RFC1035. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxiesSetQuicOverrideRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpsProxies + /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies + the server-side support for SSL features. This affects connections between + clients and the HTTPS proxy load balancer. They do not affect the connection + between the load balancer and the backends. + operationId: compute.targetHttpsProxies.setSslPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource whose SSL policy is to + be set. The name must be 1-63 characters long, and comply with RFC1035. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslPolicyReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpsProxies + /projects/{project}/global/targetSslProxies: + get: + description: Retrieves the list of TargetSslProxy resources available to the + specified project. + operationId: compute.targetSslProxies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetSslProxyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetSslProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a TargetSslProxy resource in the specified project using + the data included in the request. + operationId: compute.targetSslProxies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetSslProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetSslProxies + /projects/{project}/global/targetSslProxies/{targetSslProxy}: + delete: + description: Deletes the specified TargetSslProxy resource. + operationId: compute.targetSslProxies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetSslProxy resource to delete. + in: path + name: targetSslProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetSslProxies + get: + description: Returns the specified TargetSslProxy resource. Gets a list of available + target SSL proxies by making a list() request. + operationId: compute.targetSslProxies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetSslProxy resource to return. + in: path + name: targetSslProxy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetSslProxy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetSslProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the BackendService for TargetSslProxy. + operationId: compute.targetSslProxies.setBackendService + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetSslProxy resource whose BackendService resource + is to be set. + in: path + name: targetSslProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetSslProxiesSetBackendServiceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetSslProxies + /projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the ProxyHeaderType for TargetSslProxy. + operationId: compute.targetSslProxies.setProxyHeader + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetSslProxy resource whose ProxyHeader is to be + set. + in: path + name: targetSslProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetSslProxiesSetProxyHeaderRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetSslProxies + /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes SslCertificates for TargetSslProxy. + operationId: compute.targetSslProxies.setSslCertificates + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetSslProxy resource whose SslCertificate resource + is to be set. + in: path + name: targetSslProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetSslProxiesSetSslCertificatesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetSslProxies + /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the SSL policy for TargetSslProxy. The SSL policy specifies + the server-side support for SSL features. This affects connections between + clients and the SSL proxy load balancer. They do not affect the connection + between the load balancer and the backends. + operationId: compute.targetSslProxies.setSslPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetSslProxy resource whose SSL policy is to be + set. The name must be 1-63 characters long, and comply with RFC1035. + in: path + name: targetSslProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslPolicyReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetSslProxies + /projects/{project}/global/targetTcpProxies: + get: + description: Retrieves the list of TargetTcpProxy resources available to the + specified project. + operationId: compute.targetTcpProxies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetTcpProxyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetTcpProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a TargetTcpProxy resource in the specified project using + the data included in the request. + operationId: compute.targetTcpProxies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetTcpProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetTcpProxies + /projects/{project}/global/targetTcpProxies/{targetTcpProxy}: + delete: + description: Deletes the specified TargetTcpProxy resource. + operationId: compute.targetTcpProxies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetTcpProxy resource to delete. + in: path + name: targetTcpProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetTcpProxies + get: + description: Returns the specified TargetTcpProxy resource. Gets a list of available + target TCP proxies by making a list() request. + operationId: compute.targetTcpProxies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetTcpProxy resource to return. + in: path + name: targetTcpProxy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetTcpProxy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetTcpProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the BackendService for TargetTcpProxy. + operationId: compute.targetTcpProxies.setBackendService + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetTcpProxy resource whose BackendService resource + is to be set. + in: path + name: targetTcpProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetTcpProxiesSetBackendServiceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetTcpProxies + /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the ProxyHeaderType for TargetTcpProxy. + operationId: compute.targetTcpProxies.setProxyHeader + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetTcpProxy resource whose ProxyHeader is to be + set. + in: path + name: targetTcpProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetTcpProxiesSetProxyHeaderRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetTcpProxies + /projects/{project}/global/urlMaps: + get: + description: Retrieves the list of UrlMap resources available to the specified + project. + operationId: compute.urlMaps.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - urlMaps + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a UrlMap resource in the specified project using the data + included in the request. + operationId: compute.urlMaps.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMap' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - urlMaps + /projects/{project}/global/urlMaps/{urlMap}: + delete: + description: Deletes the specified UrlMap resource. + operationId: compute.urlMaps.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the UrlMap resource to delete. + in: path + name: urlMap + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - urlMaps + get: + description: Returns the specified UrlMap resource. Gets a list of available + URL maps by making a list() request. + operationId: compute.urlMaps.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the UrlMap resource to return. + in: path + name: urlMap + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMap' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - urlMaps + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified UrlMap resource with the data included in + the request. This method supports PATCH semantics and uses the JSON merge + patch format and processing rules. + operationId: compute.urlMaps.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the UrlMap resource to patch. + in: path + name: urlMap + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMap' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - urlMaps + put: + description: Updates the specified UrlMap resource with the data included in + the request. + operationId: compute.urlMaps.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the UrlMap resource to update. + in: path + name: urlMap + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMap' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - urlMaps + /projects/{project}/global/urlMaps/{urlMap}/invalidateCache: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Initiates a cache invalidation operation, invalidating the specified + path, scoped to the specified UrlMap. For more information, see [Invalidating + cached content](/cdn/docs/invalidating-cached-content). + operationId: compute.urlMaps.invalidateCache + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the UrlMap scoping this request. + in: path + name: urlMap + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CacheInvalidationRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - urlMaps + /projects/{project}/global/urlMaps/{urlMap}/validate: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Runs static validation for the UrlMap. In particular, the tests + of the provided UrlMap will be run. Calling this method does NOT create the + UrlMap. + operationId: compute.urlMaps.validate + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the UrlMap resource to be validated as. + in: path + name: urlMap + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapsValidateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapsValidateResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - urlMaps + /projects/{project}/listXpnHosts: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists all shared VPC host projects visible to the user in an organization. + operationId: compute.projects.listXpnHosts + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsListXpnHostsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/XpnHostList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/moveDisk: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Moves a persistent disk from one zone to another. + operationId: compute.projects.moveDisk + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DiskMoveRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/moveInstance: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Moves an instance and its attached persistent disks from one zone + to another. + operationId: compute.projects.moveInstance + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceMoveRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/regions: + get: + description: Retrieves the list of region resources available to the specified + project. + operationId: compute.regions.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regions + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}: + get: + description: Returns the specified Region resource. Gets a list of available + regions by making a list() request. + operationId: compute.regions.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region resource to return. + in: path + name: region + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Region' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regions + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/addresses: + get: + description: Retrieves a list of addresses contained within the specified region. + operationId: compute.addresses.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AddressList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - addresses + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates an address resource in the specified project by using the + data included in the request. + operationId: compute.addresses.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - addresses + /projects/{project}/regions/{region}/addresses/{address}: + delete: + description: Deletes the specified address resource. + operationId: compute.addresses.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the address resource to delete. + in: path + name: address + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - addresses + get: + description: Returns the specified address resource. + operationId: compute.addresses.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the address resource to return. + in: path + name: address + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - addresses + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/autoscalers: + get: + description: Retrieves a list of autoscalers contained within the specified + region. + operationId: compute.regionAutoscalers.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionAutoscalerList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionAutoscalers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates an autoscaler in the specified project using the data included + in the request. This method supports PATCH semantics and uses the JSON merge + patch format and processing rules. + operationId: compute.regionAutoscalers.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the autoscaler to patch. + in: query + name: autoscaler + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionAutoscalers + post: + description: Creates an autoscaler in the specified project using the data included + in the request. + operationId: compute.regionAutoscalers.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionAutoscalers + put: + description: Updates an autoscaler in the specified project using the data included + in the request. + operationId: compute.regionAutoscalers.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the autoscaler to update. + in: query + name: autoscaler + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionAutoscalers + /projects/{project}/regions/{region}/autoscalers/{autoscaler}: + delete: + description: Deletes the specified autoscaler. + operationId: compute.regionAutoscalers.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the autoscaler to delete. + in: path + name: autoscaler + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionAutoscalers + get: + description: Returns the specified autoscaler. + operationId: compute.regionAutoscalers.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the autoscaler to return. + in: path + name: autoscaler + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionAutoscalers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/backendServices: + get: + description: Retrieves the list of regional BackendService resources available + to the specified project in the given region. + operationId: compute.regionBackendServices.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendServiceList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionBackendServices + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a regional BackendService resource in the specified project + using the data included in the request. For more information, see Backend + services overview. + operationId: compute.regionBackendServices.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionBackendServices + /projects/{project}/regions/{region}/backendServices/{backendService}: + delete: + description: Deletes the specified regional BackendService resource. + operationId: compute.regionBackendServices.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the BackendService resource to delete. + in: path + name: backendService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionBackendServices + get: + description: Returns the specified regional BackendService resource. + operationId: compute.regionBackendServices.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the BackendService resource to return. + in: path + name: backendService + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionBackendServices + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified regional BackendService resource with the + data included in the request. For more information, see Understanding backend + services This method supports PATCH semantics and uses the JSON merge patch + format and processing rules. + operationId: compute.regionBackendServices.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the BackendService resource to patch. + in: path + name: backendService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionBackendServices + put: + description: Updates the specified regional BackendService resource with the + data included in the request. For more information, see Backend services overview + . + operationId: compute.regionBackendServices.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the BackendService resource to update. + in: path + name: backendService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionBackendServices + /projects/{project}/regions/{region}/backendServices/{backendService}/getHealth: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Gets the most recent health check results for this regional BackendService. + operationId: compute.regionBackendServices.getHealth + parameters: + - in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the BackendService resource for which to get health. + in: path + name: backendService + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceGroupReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackendServiceGroupHealth' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionBackendServices + /projects/{project}/regions/{region}/commitments: + get: + description: Retrieves a list of commitments contained within the specified + region. + operationId: compute.regionCommitments.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CommitmentList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionCommitments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a commitment in the specified project using the data included + in the request. + operationId: compute.regionCommitments.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Commitment' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionCommitments + /projects/{project}/regions/{region}/commitments/{commitment}: + get: + description: Returns the specified commitment resource. Gets a list of available + commitments by making a list() request. + operationId: compute.regionCommitments.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the commitment to return. + in: path + name: commitment + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Commitment' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionCommitments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/diskTypes: + get: + description: Retrieves a list of regional disk types available to the specified + project. + operationId: compute.regionDiskTypes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionDiskTypeList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionDiskTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/diskTypes/{diskType}: + get: + description: Returns the specified regional disk type. Gets a list of available + disk types by making a list() request. + operationId: compute.regionDiskTypes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the disk type to return. + in: path + name: diskType + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskType' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionDiskTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/disks: + get: + description: Retrieves the list of persistent disks contained within the specified + region. + operationId: compute.regionDisks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionDisks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a persistent regional disk in the specified project using + the data included in the request. + operationId: compute.regionDisks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + - description: Source image to restore onto a disk. This field is optional. + in: query + name: sourceImage + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionDisks + /projects/{project}/regions/{region}/disks/{disk}: + delete: + description: Deletes the specified regional persistent disk. Deleting a regional + disk removes all the replicas of its data permanently and is irreversible. + However, deleting a disk does not delete any snapshots previously made from + the disk. You must separately delete snapshots. + operationId: compute.regionDisks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the regional persistent disk to delete. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionDisks + get: + description: Returns a specified regional persistent disk. + operationId: compute.regionDisks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the regional persistent disk to return. + in: path + name: disk + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionDisks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds existing resource policies to a regional disk. You can only + add one policy which will be applied to this disk for scheduling snapshot + creation. + operationId: compute.regionDisks.addResourcePolicies + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: The disk name for this request. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionDisksAddResourcePoliciesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionDisks + /projects/{project}/regions/{region}/disks/{disk}/createSnapshot: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a snapshot of this regional disk. + operationId: compute.regionDisks.createSnapshot + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the regional persistent disk to snapshot. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionDisks + /projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes resource policies from a regional disk. + operationId: compute.regionDisks.removeResourcePolicies + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: The disk name for this request. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionDisksRemoveResourcePoliciesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionDisks + /projects/{project}/regions/{region}/disks/{disk}/resize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Resizes the specified regional persistent disk. + operationId: compute.regionDisks.resize + parameters: + - description: The project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the regional persistent disk. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionDisksResizeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionDisks + /projects/{project}/regions/{region}/disks/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.regionDisks.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionDisks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/disks/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.regionDisks.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionDisks + /projects/{project}/regions/{region}/disks/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on the target regional disk. + operationId: compute.regionDisks.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionDisks + /projects/{project}/regions/{region}/disks/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.regionDisks.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionDisks + /projects/{project}/regions/{region}/forwardingRules: + get: + description: Retrieves a list of ForwardingRule resources available to the specified + project and region. + operationId: compute.forwardingRules.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRuleList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - forwardingRules + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a ForwardingRule resource in the specified project and + region using the data included in the request. + operationId: compute.forwardingRules.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - forwardingRules + /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}: + delete: + description: Deletes the specified ForwardingRule resource. + operationId: compute.forwardingRules.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the ForwardingRule resource to delete. + in: path + name: forwardingRule + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - forwardingRules + get: + description: Returns the specified ForwardingRule resource. + operationId: compute.forwardingRules.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the ForwardingRule resource to return. + in: path + name: forwardingRule + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRule' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - forwardingRules + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified forwarding rule with the data included in + the request. This method supports PATCH semantics and uses the JSON merge + patch format and processing rules. Currently, you can only patch the network_tier + field. + operationId: compute.forwardingRules.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the ForwardingRule resource to patch. + in: path + name: forwardingRule + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - forwardingRules + /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes target URL for forwarding rule. The new target should be + of the same type as the old target. + operationId: compute.forwardingRules.setTarget + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the ForwardingRule resource in which target is to be + set. + in: path + name: forwardingRule + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - forwardingRules + /projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on the specified resource. To learn more about + labels, read the Labeling Resources documentation. + operationId: compute.forwardingRules.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - forwardingRules + /projects/{project}/regions/{region}/healthCheckServices: + get: + description: Lists all the HealthCheckService resources that have been configured + for the specified project in the given region. + operationId: compute.regionHealthCheckServices.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheckServicesList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionHealthCheckServices + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a regional HealthCheckService resource in the specified + project and region using the data included in the request. + operationId: compute.regionHealthCheckServices.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheckService' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionHealthCheckServices + /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}: + delete: + description: Deletes the specified regional HealthCheckService. + operationId: compute.regionHealthCheckServices.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the HealthCheckService to delete. The name must be 1-63 + characters long, and comply with RFC1035. + in: path + name: healthCheckService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionHealthCheckServices + get: + description: Returns the specified regional HealthCheckService resource. + operationId: compute.regionHealthCheckServices.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the HealthCheckService to update. The name must be 1-63 + characters long, and comply with RFC1035. + in: path + name: healthCheckService + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheckService' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionHealthCheckServices + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified regional HealthCheckService resource with + the data included in the request. This method supports PATCH semantics and + uses the JSON merge patch format and processing rules. + operationId: compute.regionHealthCheckServices.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the HealthCheckService to update. The name must be 1-63 + characters long, and comply with RFC1035. + in: path + name: healthCheckService + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheckService' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionHealthCheckServices + /projects/{project}/regions/{region}/healthChecks: + get: + description: Retrieves the list of HealthCheck resources available to the specified + project. + operationId: compute.regionHealthChecks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheckList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionHealthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a HealthCheck resource in the specified project using the + data included in the request. + operationId: compute.regionHealthChecks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionHealthChecks + /projects/{project}/regions/{region}/healthChecks/{healthCheck}: + delete: + description: Deletes the specified HealthCheck resource. + operationId: compute.regionHealthChecks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the HealthCheck resource to delete. + in: path + name: healthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionHealthChecks + get: + description: Returns the specified HealthCheck resource. Gets a list of available + health checks by making a list() request. + operationId: compute.regionHealthChecks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the HealthCheck resource to return. + in: path + name: healthCheck + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionHealthChecks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates a HealthCheck resource in the specified project using the + data included in the request. This method supports PATCH semantics and uses + the JSON merge patch format and processing rules. + operationId: compute.regionHealthChecks.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the HealthCheck resource to patch. + in: path + name: healthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionHealthChecks + put: + description: Updates a HealthCheck resource in the specified project using the + data included in the request. + operationId: compute.regionHealthChecks.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the HealthCheck resource to update. + in: path + name: healthCheck + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionHealthChecks + /projects/{project}/regions/{region}/instanceGroupManagers: + get: + description: Retrieves the list of managed instance groups that are contained + within the specified region. + operationId: compute.regionInstanceGroupManagers.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagerList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionInstanceGroupManagers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a managed instance group using the information that you + specify in the request. After the group is created, instances in the group + are created using the specified instance template. This operation is marked + as DONE when the group is created even if the instances in the group have + not yet been created. You must separately verify the status of the individual + instances with the listmanagedinstances method. A regional managed instance + group can contain up to 2000 instances. + operationId: compute.regionInstanceGroupManagers.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManager' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}: + delete: + description: Deletes the specified managed instance group and all of the instances + in that group. + operationId: compute.regionInstanceGroupManagers.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the managed instance group to delete. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + get: + description: Returns all of the details about the specified managed instance + group. + operationId: compute.regionInstanceGroupManagers.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the managed instance group to return. + in: path + name: instanceGroupManager + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManager' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionInstanceGroupManagers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates a managed instance group using the information that you + specify in the request. This operation is marked as DONE when the group is + patched even if the instances in the group are still in the process of being + patched. You must separately verify the status of the individual instances + with the listmanagedinstances method. This method supports PATCH semantics + and uses the JSON merge patch format and processing rules. If you update your + group to specify a new template or instance configuration, it's possible that + your intended specification for each VM in the group is different from the + current state of that VM. To learn how to apply an updated configuration to + the VMs in a MIG, see Updating instances in a MIG. + operationId: compute.regionInstanceGroupManagers.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: The name of the instance group manager. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManager' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Flags the specified instances to be immediately removed from the + managed instance group. Abandoning an instance does not delete the instance, + but it does remove the instance from any target pools that are applied by + the managed instance group. This method reduces the targetSize of the managed + instance group by the number of instances that you abandon. This operation + is marked as DONE when the action is scheduled even if the instances have + not yet been removed from the group. You must separately verify the status + of the abandoning action with the listmanagedinstances method. If the group + is part of a backend service that has enabled connection draining, it can + take up to 60 seconds after the connection draining duration has elapsed before + the VM instance is removed or deleted. You can specify a maximum of 1000 instances + with this method per request. + operationId: compute.regionInstanceGroupManagers.abandonInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersAbandonInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Apply updates to selected instances the managed instance group. + operationId: compute.regionInstanceGroupManagers.applyUpdatesToInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request, should conform to RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The name of the managed instance group, should conform to RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersApplyUpdatesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates instances with per-instance configs in this regional managed + instance group. Instances are created using the current instance template. + The create instances operation is marked DONE if the createInstances request + is successful. The underlying actions take additional time. You must separately + verify the status of the creating or actions with the listmanagedinstances + method. + operationId: compute.regionInstanceGroupManagers.createInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region where the managed instance group is located. + It should conform to RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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. The request ID must be a valid UUID with + the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersCreateInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Flags the specified instances in the managed instance group to + be immediately deleted. The instances are also removed from any target pools + of which they were a member. This method reduces the targetSize of the managed + instance group by the number of instances that you delete. The deleteInstances + operation is marked DONE if the deleteInstances request is successful. The + underlying actions take additional time. You must separately verify the status + of the deleting action with the listmanagedinstances method. If the group + is part of a backend service that has enabled connection draining, it can + take up to 60 seconds after the connection draining duration has elapsed before + the VM instance is removed or deleted. You can specify a maximum of 1000 instances + with this method per request. + operationId: compute.regionInstanceGroupManagers.deleteInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersDeleteInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Deletes selected per-instance configs for the managed instance + group. + operationId: compute.regionInstanceGroupManagers.deletePerInstanceConfigs + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request, should conform to RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagerDeleteInstanceConfigReq' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors: + get: + description: Lists all errors thrown by actions on instances for a given regional + managed instance group. The filter and orderBy query parameters are not supported. + operationId: compute.regionInstanceGroupManagers.listErrors + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. This should conform + to RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: 'The name of the managed instance group. It must be a string + that meets the requirements in RFC1035, or an unsigned long integer: must + match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.' + in: path + name: instanceGroupManager + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersListErrorsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionInstanceGroupManagers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists the instances in the managed instance group and instances + that are scheduled to be created. The list includes any current actions that + the group has scheduled for its instances. The orderBy query parameter is + not supported. + operationId: compute.regionInstanceGroupManagers.listManagedInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersListInstancesResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists all of the per-instance configs defined for the managed instance + group. The orderBy query parameter is not supported. + operationId: compute.regionInstanceGroupManagers.listPerInstanceConfigs + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request, should conform to RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersListInstanceConfigsResp' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Inserts or patches per-instance configs for the managed instance + group. perInstanceConfig.name serves as a key used to distinguish whether + to perform insert or patch. + operationId: compute.regionInstanceGroupManagers.patchPerInstanceConfigs + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request, should conform to RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagerPatchInstanceConfigReq' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Flags the specified VM instances in the managed instance group + to be immediately recreated. Each instance is recreated using the group's + current configuration. This operation is marked as DONE when the flag is set + even if the instances have not yet been recreated. You must separately verify + the status of each instance by checking its currentAction field; for more + information, see Checking the status of managed instances. If the group is + part of a backend service that has enabled connection draining, it can take + up to 60 seconds after the connection draining duration has elapsed before + the VM instance is removed or deleted. You can specify a maximum of 1000 instances + with this method per request. + operationId: compute.regionInstanceGroupManagers.recreateInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersRecreateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the intended size of the managed instance group. If you + increase the size, the group creates new instances using the current instance + template. If you decrease the size, the group deletes one or more instances. + The resize operation is marked DONE if the resize request is successful. The + underlying actions take additional time. You must separately verify the status + of the creating or deleting actions with the listmanagedinstances method. + If the group is part of a backend service that has enabled connection draining, + it can take up to 60 seconds after the connection draining duration has elapsed + before the VM instance is removed or deleted. + operationId: compute.regionInstanceGroupManagers.resize + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - description: Number of instances that should exist in this instance group + manager. + in: query + name: size + required: true + schema: + minimum: 0 + type: integer + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the instance template to use when creating new instances or + recreating instances in this group. Existing instances are not affected. + operationId: compute.regionInstanceGroupManagers.setInstanceTemplate + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersSetTemplateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Modifies the target pools to which all new instances in this group + are assigned. Existing instances in the group are not affected. + operationId: compute.regionInstanceGroupManagers.setTargetPools + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersSetTargetPoolsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Inserts or updates per-instance configs for the managed instance + group. perInstanceConfig.name serves as a key used to distinguish whether + to perform insert or patch. + operationId: compute.regionInstanceGroupManagers.updatePerInstanceConfigs + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request, should conform to RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagerUpdateInstanceConfigReq' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroupManagers + /projects/{project}/regions/{region}/instanceGroups: + get: + description: Retrieves the list of instance group resources contained within + the specified region. + operationId: compute.regionInstanceGroups.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionInstanceGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}: + get: + description: Returns the specified instance group resource. + operationId: compute.regionInstanceGroups.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the instance group resource to return. + in: path + name: instanceGroup + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroup' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionInstanceGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists the instances in the specified instance group and displays + information about the named ports. Depending on the specified options, this + method can list all instances or only the instances that are running. The + orderBy query parameter is not supported. + operationId: compute.regionInstanceGroups.listInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the regional instance group for which we want to list + the instances. + in: path + name: instanceGroup + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupsListInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupsListInstances' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionInstanceGroups + /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the named ports for the specified regional instance group. + operationId: compute.regionInstanceGroups.setNamedPorts + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: The name of the regional instance group where the named ports + are updated. + in: path + name: instanceGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupsSetNamedPortsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstanceGroups + /projects/{project}/regions/{region}/instances/bulkInsert: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates multiple instances in a given region. Count specifies the + number of instances to create. + operationId: compute.regionInstances.bulkInsert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkInsertInstanceResource' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionInstances + /projects/{project}/regions/{region}/interconnectAttachments: + get: + description: Retrieves the list of interconnect attachments contained within + the specified region. + operationId: compute.interconnectAttachments.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectAttachmentList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - interconnectAttachments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates an InterconnectAttachment in the specified project using + the data included in the request. + operationId: compute.interconnectAttachments.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + - description: If true, the request will not be committed. + in: query + name: validateOnly + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectAttachment' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - interconnectAttachments + /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}: + delete: + description: Deletes the specified interconnect attachment. + operationId: compute.interconnectAttachments.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the interconnect attachment to delete. + in: path + name: interconnectAttachment + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - interconnectAttachments + get: + description: Returns the specified interconnect attachment. + operationId: compute.interconnectAttachments.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the interconnect attachment to return. + in: path + name: interconnectAttachment + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectAttachment' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - interconnectAttachments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified interconnect attachment with the data included + in the request. This method supports PATCH semantics and uses the JSON merge + patch format and processing rules. + operationId: compute.interconnectAttachments.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the interconnect attachment to patch. + in: path + name: interconnectAttachment + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectAttachment' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - interconnectAttachments + /projects/{project}/regions/{region}/networkEndpointGroups: + get: + description: Retrieves the list of regional network endpoint groups available + to the specified project in the given region. + operationId: compute.regionNetworkEndpointGroups.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionNetworkEndpointGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a network endpoint group in the specified project using + the parameters that are included in the request. + operationId: compute.regionNetworkEndpointGroups.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region where you want to create the network endpoint + group. It should comply with RFC1035. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionNetworkEndpointGroups + /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}: + 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. + operationId: compute.regionNetworkEndpointGroups.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The name of the network endpoint group to delete. It should comply + with RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionNetworkEndpointGroups + get: + description: Returns the specified network endpoint group. Gets a list of available + network endpoint groups by making a list() request. + operationId: compute.regionNetworkEndpointGroups.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The name of the network endpoint group. It should comply with + RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroup' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionNetworkEndpointGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/nodeTemplates: + get: + description: Retrieves a list of node templates available to the specified project. + operationId: compute.nodeTemplates.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTemplateList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeTemplates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a NodeTemplate resource in the specified project using + the data included in the request. + operationId: compute.nodeTemplates.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTemplate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeTemplates + /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}: + delete: + description: Deletes the specified NodeTemplate resource. + operationId: compute.nodeTemplates.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the NodeTemplate resource to delete. + in: path + name: nodeTemplate + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeTemplates + get: + description: Returns the specified node template. Gets a list of available node + templates by making a list() request. + operationId: compute.nodeTemplates.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the node template to return. + in: path + name: nodeTemplate + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTemplate' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeTemplates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.nodeTemplates.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeTemplates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.nodeTemplates.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeTemplates + /projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.nodeTemplates.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeTemplates + /projects/{project}/regions/{region}/notificationEndpoints: + get: + description: Lists the NotificationEndpoints for a project in the given region. + operationId: compute.regionNotificationEndpoints.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpointList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionNotificationEndpoints + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Create a NotificationEndpoint in the specified project in the given + region using the parameters that are included in the request. + operationId: compute.regionNotificationEndpoints.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoint' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionNotificationEndpoints + /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}: + delete: + description: Deletes the specified NotificationEndpoint in the given region + operationId: compute.regionNotificationEndpoints.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the NotificationEndpoint resource to delete. + in: path + name: notificationEndpoint + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionNotificationEndpoints + get: + description: Returns the specified NotificationEndpoint resource in the given + region. + operationId: compute.regionNotificationEndpoints.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the NotificationEndpoint resource to return. + in: path + name: notificationEndpoint + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoint' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionNotificationEndpoints + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/operations: + get: + description: Retrieves a list of Operation resources contained within the specified + region. + operationId: compute.regionOperations.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperationList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/operations/{operation}: + delete: + description: Deletes the specified region-specific Operations resource. + operationId: compute.regionOperations.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Operations resource to delete. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionOperations + get: + description: Retrieves the specified region-specific Operations resource. + operationId: compute.regionOperations.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Operations resource to return. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/operations/{operation}/wait: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Waits for the specified Operation resource to return as `DONE` + or for the request to approach the 2 minute deadline, and retrieves the specified + Operation resource. This method differs from the `GET` method in that it waits + for no more than the default deadline (2 minutes) and then returns the current + state of the operation, which might be `DONE` or still in progress. This method + is called on a best-effort basis. Specifically: - In uncommon cases, when + the server is overloaded, the request might return before the default deadline + is reached, or might return after zero seconds. - If the default deadline + is reached, there is no guarantee that the operation is actually done when + the method returns. Be prepared to retry if the operation is not `DONE`. ' + operationId: compute.regionOperations.wait + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Operations resource to return. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionOperations + /projects/{project}/regions/{region}/packetMirrorings: + get: + description: Retrieves a list of PacketMirroring resources available to the + specified project and region. + operationId: compute.packetMirrorings.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PacketMirroringList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - packetMirrorings + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a PacketMirroring resource in the specified project and + region using the data included in the request. + operationId: compute.packetMirrorings.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PacketMirroring' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - packetMirrorings + /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}: + delete: + description: Deletes the specified PacketMirroring resource. + operationId: compute.packetMirrorings.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the PacketMirroring resource to delete. + in: path + name: packetMirroring + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - packetMirrorings + get: + description: Returns the specified PacketMirroring resource. + operationId: compute.packetMirrorings.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the PacketMirroring resource to return. + in: path + name: packetMirroring + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PacketMirroring' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - packetMirrorings + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified PacketMirroring resource with the data included + in the request. This method supports PATCH semantics and uses JSON merge patch + format and processing rules. + operationId: compute.packetMirrorings.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the PacketMirroring resource to patch. + in: path + name: packetMirroring + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PacketMirroring' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - packetMirrorings + /projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.packetMirrorings.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - packetMirrorings + /projects/{project}/regions/{region}/publicDelegatedPrefixes: + get: + description: Lists the PublicDelegatedPrefixes for a project in the given region. + operationId: compute.publicDelegatedPrefixes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region of this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefixList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - publicDelegatedPrefixes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a PublicDelegatedPrefix in the specified project in the + given region using the parameters that are included in the request. + operationId: compute.publicDelegatedPrefixes.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region of this request. + in: path + name: region + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefix' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - publicDelegatedPrefixes + /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}: + delete: + description: Deletes the specified PublicDelegatedPrefix in the given region. + operationId: compute.publicDelegatedPrefixes.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region of this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the PublicDelegatedPrefix resource to delete. + in: path + name: publicDelegatedPrefix + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - publicDelegatedPrefixes + get: + description: Returns the specified PublicDelegatedPrefix resource in the given + region. + operationId: compute.publicDelegatedPrefixes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region of this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the PublicDelegatedPrefix resource to return. + in: path + name: publicDelegatedPrefix + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefix' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - publicDelegatedPrefixes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified PublicDelegatedPrefix resource with the data + included in the request. This method supports PATCH semantics and uses JSON + merge patch format and processing rules. + operationId: compute.publicDelegatedPrefixes.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the PublicDelegatedPrefix resource to patch. + in: path + name: publicDelegatedPrefix + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefix' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - publicDelegatedPrefixes + /projects/{project}/regions/{region}/resourcePolicies: + get: + description: A list all the resource policies that have been configured for + the specified project in specified region. + operationId: compute.resourcePolicies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourcePolicyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - resourcePolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new resource policy. + operationId: compute.resourcePolicies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResourcePolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - resourcePolicies + /projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}: + delete: + description: Deletes the specified resource policy. + operationId: compute.resourcePolicies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the resource policy to delete. + in: path + name: resourcePolicy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - resourcePolicies + get: + description: Retrieves all information of the specified resource policy. + operationId: compute.resourcePolicies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the resource policy to retrieve. + in: path + name: resourcePolicy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResourcePolicy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - resourcePolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.resourcePolicies.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - resourcePolicies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.resourcePolicies.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - resourcePolicies + /projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.resourcePolicies.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - resourcePolicies + /projects/{project}/regions/{region}/routers: + get: + description: Retrieves a list of Router resources available to the specified + project. + operationId: compute.routers.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RouterList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - routers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a Router resource in the specified project and region using + the data included in the request. + operationId: compute.routers.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Router' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - routers + /projects/{project}/regions/{region}/routers/{router}: + delete: + description: Deletes the specified Router resource. + operationId: compute.routers.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Router resource to delete. + in: path + name: router + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - routers + get: + description: Returns the specified Router resource. Gets a list of available + routers by making a list() request. + operationId: compute.routers.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Router resource to return. + in: path + name: router + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Router' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - routers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified Router resource with the data included in + the request. This method supports PATCH semantics and uses JSON merge patch + format and processing rules. + operationId: compute.routers.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Router resource to patch. + in: path + name: router + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Router' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - routers + put: + description: Updates the specified Router resource with the data included in + the request. This method conforms to PUT semantics, which requests that the + state of the target resource be created or replaced with the state defined + by the representation enclosed in the request message payload. + operationId: compute.routers.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Router resource to update. + in: path + name: router + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Router' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - routers + /projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo: + get: + description: Retrieves runtime Nat mapping information of VM endpoints. + operationId: compute.routers.getNatMappingInfo + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Router resource to query for Nat Mapping information + of VM endpoints. + in: path + name: router + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VmEndpointNatMappingsList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - routers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/routers/{router}/getRouterStatus: + get: + description: Retrieves runtime information of the specified router. + operationId: compute.routers.getRouterStatus + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Router resource to query. + in: path + name: router + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RouterStatusResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - routers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/routers/{router}/preview: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Preview fields auto-generated during router create and update operations. + Calling this method does NOT create or update the router. + operationId: compute.routers.preview + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Router resource to query. + in: path + name: router + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Router' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutersPreviewResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - routers + /projects/{project}/regions/{region}/serviceAttachments: + get: + description: Lists the ServiceAttachments for a project in the given scope. + operationId: compute.serviceAttachments.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region of this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAttachmentList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - serviceAttachments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a ServiceAttachment in the specified project in the given + scope using the parameters that are included in the request. + operationId: compute.serviceAttachments.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region of this request. + in: path + name: region + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAttachment' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - serviceAttachments + /projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.serviceAttachments.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - serviceAttachments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.serviceAttachments.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - serviceAttachments + /projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.serviceAttachments.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - serviceAttachments + /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}: + delete: + description: Deletes the specified ServiceAttachment in the given scope + operationId: compute.serviceAttachments.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region of this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the ServiceAttachment resource to delete. + in: path + name: serviceAttachment + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - serviceAttachments + get: + description: Returns the specified ServiceAttachment resource in the given scope. + operationId: compute.serviceAttachments.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region of this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the ServiceAttachment resource to return. + in: path + name: serviceAttachment + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAttachment' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - serviceAttachments + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified ServiceAttachment resource with the data + included in the request. This method supports PATCH semantics and uses JSON + merge patch format and processing rules. + operationId: compute.serviceAttachments.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The region scoping this request and should conform to RFC1035. + in: path + name: region + required: true + schema: + type: string + - description: The resource id of the ServiceAttachment to patch. It should + conform to RFC1035 resource name or be a string form on an unsigned long + number. + in: path + name: serviceAttachment + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAttachment' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - serviceAttachments + /projects/{project}/regions/{region}/sslCertificates: + get: + description: Retrieves the list of SslCertificate resources available to the + specified project in the specified region. + operationId: compute.regionSslCertificates.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SslCertificateList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionSslCertificates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a SslCertificate resource in the specified project and + region using the data included in the request + operationId: compute.regionSslCertificates.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslCertificate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionSslCertificates + /projects/{project}/regions/{region}/sslCertificates/{sslCertificate}: + delete: + description: Deletes the specified SslCertificate resource in the region. + operationId: compute.regionSslCertificates.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the SslCertificate resource to delete. + in: path + name: sslCertificate + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionSslCertificates + get: + description: Returns the specified SslCertificate resource in the specified + region. Get a list of available SSL certificates by making a list() request. + operationId: compute.regionSslCertificates.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the SslCertificate resource to return. + in: path + name: sslCertificate + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SslCertificate' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionSslCertificates + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/subnetworks: + get: + description: Retrieves a list of subnetworks available to the specified project. + operationId: compute.subnetworks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SubnetworkList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - subnetworks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a subnetwork in the specified project using the data included + in the request. + operationId: compute.subnetworks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Subnetwork' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - subnetworks + /projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.subnetworks.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - subnetworks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.subnetworks.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - subnetworks + /projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.subnetworks.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - subnetworks + /projects/{project}/regions/{region}/subnetworks/{subnetwork}: + delete: + description: Deletes the specified subnetwork. + operationId: compute.subnetworks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Subnetwork resource to delete. + in: path + name: subnetwork + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - subnetworks + get: + description: Returns the specified subnetwork. Gets a list of available subnetworks + list() request. + operationId: compute.subnetworks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Subnetwork resource to return. + in: path + name: subnetwork + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Subnetwork' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - subnetworks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified subnetwork with the data included in the + request. Only certain fields can be updated with a patch request as indicated + in the field descriptions. You must specify the current fingerprint of the + subnetwork resource being patched. + operationId: compute.subnetworks.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Subnetwork resource to patch. + in: path + name: subnetwork + required: true + schema: + type: string + - description: 'The drain timeout specifies the upper bound in seconds on the + amount of time allowed to drain connections from the current ACTIVE subnetwork + to the current BACKUP subnetwork. The drain timeout is only applicable when + the following conditions are true: - the subnetwork being patched has purpose + = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = + BACKUP - the patch request is setting the role to ACTIVE. Note that after + this patch operation the roles of the ACTIVE and BACKUP subnetworks will + be swapped.' + in: query + name: drainTimeoutSeconds + schema: + type: integer + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Subnetwork' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - subnetworks + /projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Expands the IP CIDR range of the subnetwork to a specified value. + operationId: compute.subnetworks.expandIpCidrRange + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Subnetwork resource to update. + in: path + name: subnetwork + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubnetworksExpandIpCidrRangeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - subnetworks + /projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Set whether VMs in this subnet can access Google services without + assigning external IP addresses through Private Google Access. + operationId: compute.subnetworks.setPrivateIpGoogleAccess + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the Subnetwork resource. + in: path + name: subnetwork + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubnetworksSetPrivateIpGoogleAccessRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - subnetworks + /projects/{project}/regions/{region}/targetHttpProxies: + get: + description: Retrieves the list of TargetHttpProxy resources available to the + specified project in the specified region. + operationId: compute.regionTargetHttpProxies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpProxyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionTargetHttpProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a TargetHttpProxy resource in the specified project and + region using the data included in the request. + operationId: compute.regionTargetHttpProxies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionTargetHttpProxies + /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}: + delete: + description: Deletes the specified TargetHttpProxy resource. + operationId: compute.regionTargetHttpProxies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetHttpProxy resource to delete. + in: path + name: targetHttpProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionTargetHttpProxies + get: + description: Returns the specified TargetHttpProxy resource in the specified + region. Gets a list of available target HTTP proxies by making a list() request. + operationId: compute.regionTargetHttpProxies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetHttpProxy resource to return. + in: path + name: targetHttpProxy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpProxy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionTargetHttpProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the URL map for TargetHttpProxy. + operationId: compute.regionTargetHttpProxies.setUrlMap + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetHttpProxy to set a URL map for. + in: path + name: targetHttpProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionTargetHttpProxies + /projects/{project}/regions/{region}/targetHttpsProxies: + get: + description: Retrieves the list of TargetHttpsProxy resources available to the + specified project in the specified region. + operationId: compute.regionTargetHttpsProxies.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxyList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionTargetHttpsProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a TargetHttpsProxy resource in the specified project and + region using the data included in the request. + operationId: compute.regionTargetHttpsProxies.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionTargetHttpsProxies + /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}: + delete: + description: Deletes the specified TargetHttpsProxy resource. + operationId: compute.regionTargetHttpsProxies.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource to delete. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionTargetHttpsProxies + get: + description: Returns the specified TargetHttpsProxy resource in the specified + region. Gets a list of available target HTTP proxies by making a list() request. + operationId: compute.regionTargetHttpsProxies.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource to return. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionTargetHttpsProxies + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Replaces SslCertificates for TargetHttpsProxy. + operationId: compute.regionTargetHttpsProxies.setSslCertificates + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource to set an SslCertificates + resource for. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionTargetHttpsProxiesSetSslCertificatesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionTargetHttpsProxies + /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the URL map for TargetHttpsProxy. + operationId: compute.regionTargetHttpsProxies.setUrlMap + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy to set a URL map for. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionTargetHttpsProxies + /projects/{project}/regions/{region}/targetPools: + get: + description: Retrieves a list of target pools available to the specified project + and region. + operationId: compute.targetPools.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPoolList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetPools + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a target pool in the specified project and region using + the data included in the request. + operationId: compute.targetPools.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPool' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetPools + /projects/{project}/regions/{region}/targetPools/{targetPool}: + delete: + description: Deletes the specified target pool. + operationId: compute.targetPools.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetPool resource to delete. + in: path + name: targetPool + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetPools + get: + description: Returns the specified target pool. Gets a list of available target + pools by making a list() request. + operationId: compute.targetPools.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetPool resource to return. + in: path + name: targetPool + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPool' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetPools + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds health check URLs to a target pool. + operationId: compute.targetPools.addHealthCheck + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the target pool to add a health check to. + in: path + name: targetPool + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPoolsAddHealthCheckRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetPools + /projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds an instance to a target pool. + operationId: compute.targetPools.addInstance + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetPool resource to add instances to. + in: path + name: targetPool + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPoolsAddInstanceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetPools + /projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Gets the most recent health check results for each IP for the instance + that is referenced by the given target pool. + operationId: compute.targetPools.getHealth + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetPool resource to which the queried instance + belongs. + in: path + name: targetPool + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPoolInstanceHealth' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetPools + /projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes health check URL from a target pool. + operationId: compute.targetPools.removeHealthCheck + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the target pool to remove health checks from. + in: path + name: targetPool + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPoolsRemoveHealthCheckRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetPools + /projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes instance URL from a target pool. + operationId: compute.targetPools.removeInstance + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetPool resource to remove instances from. + in: path + name: targetPool + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPoolsRemoveInstanceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetPools + /projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes a backup target pool's configurations. + operationId: compute.targetPools.setBackup + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the TargetPool resource to set a backup pool for. + in: path + name: targetPool + required: true + schema: + type: string + - description: New failoverRatio value for the target pool. + in: query + name: failoverRatio + schema: + type: number + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetPools + /projects/{project}/regions/{region}/targetVpnGateways: + get: + description: Retrieves a list of target VPN gateways available to the specified + project and region. + operationId: compute.targetVpnGateways.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetVpnGatewayList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetVpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a target VPN gateway in the specified project and region + using the data included in the request. + operationId: compute.targetVpnGateways.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetVpnGateway' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetVpnGateways + /projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}: + delete: + description: Deletes the specified target VPN gateway. + operationId: compute.targetVpnGateways.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the target VPN gateway to delete. + in: path + name: targetVpnGateway + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetVpnGateways + get: + description: Returns the specified target VPN gateway. Gets a list of available + target VPN gateways by making a list() request. + operationId: compute.targetVpnGateways.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the target VPN gateway to return. + in: path + name: targetVpnGateway + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetVpnGateway' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetVpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/urlMaps: + get: + description: Retrieves the list of UrlMap resources available to the specified + project in the specified region. + operationId: compute.regionUrlMaps.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionUrlMaps + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a UrlMap resource in the specified project using the data + included in the request. + operationId: compute.regionUrlMaps.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: 'begin_interface: MixerMutationRequestBuilder Request ID to support + idempotency.' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMap' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionUrlMaps + /projects/{project}/regions/{region}/urlMaps/{urlMap}: + delete: + description: Deletes the specified UrlMap resource. + operationId: compute.regionUrlMaps.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the UrlMap resource to delete. + in: path + name: urlMap + required: true + schema: + type: string + - description: 'begin_interface: MixerMutationRequestBuilder Request ID to support + idempotency.' + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionUrlMaps + get: + description: Returns the specified UrlMap resource. Gets a list of available + URL maps by making a list() request. + operationId: compute.regionUrlMaps.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the UrlMap resource to return. + in: path + name: urlMap + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMap' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - regionUrlMaps + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches the specified UrlMap resource with the data included in + the request. This method supports PATCH semantics and uses JSON merge patch + format and processing rules. + operationId: compute.regionUrlMaps.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the UrlMap resource to patch. + in: path + name: urlMap + required: true + schema: + type: string + - description: 'begin_interface: MixerMutationRequestBuilder Request ID to support + idempotency.' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMap' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionUrlMaps + put: + description: Updates the specified UrlMap resource with the data included in + the request. + operationId: compute.regionUrlMaps.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the UrlMap resource to update. + in: path + name: urlMap + required: true + schema: + type: string + - description: 'begin_interface: MixerMutationRequestBuilder Request ID to support + idempotency.' + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMap' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionUrlMaps + /projects/{project}/regions/{region}/urlMaps/{urlMap}/validate: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Runs static validation for the UrlMap. In particular, the tests + of the provided UrlMap will be run. Calling this method does NOT create the + UrlMap. + operationId: compute.regionUrlMaps.validate + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region scoping this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the UrlMap resource to be validated as. + in: path + name: urlMap + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionUrlMapsValidateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapsValidateResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - regionUrlMaps + /projects/{project}/regions/{region}/vpnGateways: + get: + description: Retrieves a list of VPN gateways available to the specified project + and region. + operationId: compute.vpnGateways.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VpnGatewayList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - vpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a VPN gateway in the specified project and region using + the data included in the request. + operationId: compute.vpnGateways.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VpnGateway' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - vpnGateways + /projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on a VpnGateway. To learn more about labels, read + the Labeling Resources documentation. + operationId: compute.vpnGateways.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - vpnGateways + /projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.vpnGateways.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - vpnGateways + /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}: + delete: + description: Deletes the specified VPN gateway. + operationId: compute.vpnGateways.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the VPN gateway to delete. + in: path + name: vpnGateway + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - vpnGateways + get: + description: Returns the specified VPN gateway. Gets a list of available VPN + gateways by making a list() request. + operationId: compute.vpnGateways.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the VPN gateway to return. + in: path + name: vpnGateway + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VpnGateway' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - vpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus: + get: + description: Returns the status for the specified VPN gateway. + operationId: compute.vpnGateways.getStatus + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the VPN gateway to return. + in: path + name: vpnGateway + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VpnGatewaysGetStatusResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - vpnGateways + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/regions/{region}/vpnTunnels: + get: + description: Retrieves a list of VpnTunnel resources contained in the specified + project and region. + operationId: compute.vpnTunnels.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VpnTunnelList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - vpnTunnels + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a VpnTunnel resource in the specified project and region + using the data included in the request. + operationId: compute.vpnTunnels.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VpnTunnel' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - vpnTunnels + /projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}: + delete: + description: Deletes the specified VpnTunnel resource. + operationId: compute.vpnTunnels.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the VpnTunnel resource to delete. + in: path + name: vpnTunnel + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - vpnTunnels + get: + description: Returns the specified VpnTunnel resource. Gets a list of available + VPN tunnels by making a list() request. + operationId: compute.vpnTunnels.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the region for this request. + in: path + name: region + required: true + schema: + type: string + - description: Name of the VpnTunnel resource to return. + in: path + name: vpnTunnel + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VpnTunnel' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - vpnTunnels + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/setCommonInstanceMetadata: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets metadata common to all instances within the specified project + using the data included in the request. + operationId: compute.projects.setCommonInstanceMetadata + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Metadata' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/setDefaultNetworkTier: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the default network tier of the project. The default network + tier is used when an address/forwardingRule/instance is created without specifying + the network tier field. + operationId: compute.projects.setDefaultNetworkTier + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsSetDefaultNetworkTierRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - projects + /projects/{project}/setUsageExportBucket: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Enables the usage export feature and sets the usage export bucket + where reports are stored. If you provide an empty request body using this + method, the usage export feature will be disabled. + operationId: compute.projects.setUsageExportBucket + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UsageExportLocation' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - projects + /projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the URL map for TargetHttpProxy. + operationId: compute.targetHttpProxies.setUrlMap + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpProxy to set a URL map for. + in: path + name: targetHttpProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpProxies + /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Replaces SslCertificates for TargetHttpsProxy. + operationId: compute.targetHttpsProxies.setSslCertificates + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource to set an SslCertificates + resource for. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetHttpsProxiesSetSslCertificatesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpsProxies + /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the URL map for TargetHttpsProxy. + operationId: compute.targetHttpsProxies.setUrlMap + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the TargetHttpsProxy resource whose URL map is to be + set. + in: path + name: targetHttpsProxy + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UrlMapReference' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetHttpsProxies + /projects/{project}/zones: + get: + description: Retrieves the list of Zone resources available to the specified + project. + operationId: compute.zones.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - zones + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}: + get: + description: Returns the specified Zone resource. Gets a list of available zones + by making a list() request. + operationId: compute.zones.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone resource to return. + in: path + name: zone + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - zones + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/acceleratorTypes: + get: + description: Retrieves a list of accelerator types that are available to the + specified project. + operationId: compute.acceleratorTypes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AcceleratorTypeList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - acceleratorTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}: + get: + description: Returns the specified accelerator type. + operationId: compute.acceleratorTypes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the accelerator type to return. + in: path + name: acceleratorType + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AcceleratorType' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - acceleratorTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/autoscalers: + get: + description: Retrieves a list of autoscalers contained within the specified + zone. + operationId: compute.autoscalers.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AutoscalerList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - autoscalers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates an autoscaler in the specified project using the data included + in the request. This method supports PATCH semantics and uses the JSON merge + patch format and processing rules. + operationId: compute.autoscalers.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the autoscaler to patch. + in: query + name: autoscaler + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - autoscalers + post: + description: Creates an autoscaler in the specified project using the data included + in the request. + operationId: compute.autoscalers.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - autoscalers + put: + description: Updates an autoscaler in the specified project using the data included + in the request. + operationId: compute.autoscalers.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the autoscaler to update. + in: query + name: autoscaler + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - autoscalers + /projects/{project}/zones/{zone}/autoscalers/{autoscaler}: + delete: + description: Deletes the specified autoscaler. + operationId: compute.autoscalers.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the autoscaler to delete. + in: path + name: autoscaler + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - autoscalers + get: + description: Returns the specified autoscaler resource. Gets a list of available + autoscalers by making a list() request. + operationId: compute.autoscalers.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the autoscaler to return. + in: path + name: autoscaler + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - autoscalers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/diskTypes: + get: + description: Retrieves a list of disk types available to the specified project. + operationId: compute.diskTypes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskTypeList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - diskTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/diskTypes/{diskType}: + get: + description: Returns the specified disk type. Gets a list of available disk + types by making a list() request. + operationId: compute.diskTypes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the disk type to return. + in: path + name: diskType + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskType' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - diskTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/disks: + get: + description: Retrieves a list of persistent disks contained within the specified + zone. + operationId: compute.disks.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DiskList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a persistent disk in the specified project using the data + in the request. You can create a disk from a source (sourceImage, sourceSnapshot, + or sourceDisk) or create an empty 500 GB data disk by omitting all properties. + You can also create a disk that is larger than the default size by specifying + the sizeGb property. + operationId: compute.disks.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + - description: Source image to restore onto a disk. This field is optional. + in: query + name: sourceImage + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{disk}: + delete: + description: Deletes the specified persistent disk. Deleting a disk removes + its data permanently and is irreversible. However, deleting a disk does not + delete any snapshots previously made from the disk. You must separately delete + snapshots. + operationId: compute.disks.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the persistent disk to delete. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + get: + description: Returns a specified persistent disk. Gets a list of available persistent + disks by making a list() request. + operationId: compute.disks.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the persistent disk to return. + in: path + name: disk + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds existing resource policies to a disk. You can only add one + policy which will be applied to this disk for scheduling snapshot creation. + operationId: compute.disks.addResourcePolicies + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The disk name for this request. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksAddResourcePoliciesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{disk}/createSnapshot: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a snapshot of a specified persistent disk. + operationId: compute.disks.createSnapshot + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the persistent disk to snapshot. + in: path + name: disk + required: true + schema: + type: string + - description: '[Input Only] Whether to attempt an application consistent snapshot + by informing the OS to prepare for the snapshot process. Currently only + supported on Windows instances using the Volume Shadow Copy Service (VSS).' + in: query + name: guestFlush + schema: + type: boolean + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes resource policies from a disk. + operationId: compute.disks.removeResourcePolicies + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The disk name for this request. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksRemoveResourcePoliciesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{disk}/resize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Resizes the specified persistent disk. You can only increase the + size of the disk. + operationId: compute.disks.resize + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the persistent disk. + in: path + name: disk + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksResizeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.disks.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.disks.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{resource}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the labels on a disk. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.disks.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - disks + /projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.disks.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - disks + /projects/{project}/zones/{zone}/imageFamilyViews/{family}: + get: + description: Returns the latest image that is part of an image family, is not + deprecated and is rolled out in the specified zone. + operationId: compute.imageFamilyViews.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the image family to search for. + in: path + name: family + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ImageFamilyView' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - imageFamilyViews + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instanceGroupManagers: + get: + description: Retrieves a list of managed instance groups that are contained + within the specified project and zone. + operationId: compute.instanceGroupManagers.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagerList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroupManagers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a managed instance group using the information that you + specify in the request. After the group is created, instances in the group + are created using the specified instance template. This operation is marked + as DONE when the group is created even if the instances in the group have + not yet been created. You must separately verify the status of the individual + instances with the listmanagedinstances method. A managed instance group can + have up to 1000 VM instances per group. Please contact Cloud Support if you + need an increase in this limit. + operationId: compute.instanceGroupManagers.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where you want to create the managed instance + group. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManager' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}: + delete: + description: Deletes the specified managed instance group and all of the instances + in that group. Note that the instance group must not belong to a backend service. + Read Deleting an instance group for more information. + operationId: compute.instanceGroupManagers.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group to delete. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + get: + description: Returns all of the details about the specified managed instance + group. Gets a list of available managed instance groups by making a list() + request. + operationId: compute.instanceGroupManagers.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManager' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroupManagers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates a managed instance group using the information that you + specify in the request. This operation is marked as DONE when the group is + patched even if the instances in the group are still in the process of being + patched. You must separately verify the status of the individual instances + with the listManagedInstances method. This method supports PATCH semantics + and uses the JSON merge patch format and processing rules. If you update your + group to specify a new template or instance configuration, it's possible that + your intended specification for each VM in the group is different from the + current state of that VM. To learn how to apply an updated configuration to + the VMs in a MIG, see Updating instances in a MIG. + operationId: compute.instanceGroupManagers.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where you want to create the managed instance + group. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the instance group manager. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManager' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Flags the specified instances to be removed from the managed instance + group. Abandoning an instance does not delete the instance, but it does remove + the instance from any target pools that are applied by the managed instance + group. This method reduces the targetSize of the managed instance group by + the number of instances that you abandon. This operation is marked as DONE + when the action is scheduled even if the instances have not yet been removed + from the group. You must separately verify the status of the abandoning action + with the listmanagedinstances method. If the group is part of a backend service + that has enabled connection draining, it can take up to 60 seconds after the + connection draining duration has elapsed before the VM instance is removed + or deleted. You can specify a maximum of 1000 instances with this method per + request. + operationId: compute.instanceGroupManagers.abandonInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersAbandonInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Applies changes to selected instances on the managed instance group. + This method can be used to apply new overrides and/or new versions. + operationId: compute.instanceGroupManagers.applyUpdatesToInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + Should conform to RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group, should conform to RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersApplyUpdatesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates instances with per-instance configs in this managed instance + group. Instances are created using the current instance template. The create + instances operation is marked DONE if the createInstances request is successful. + The underlying actions take additional time. You must separately verify the + status of the creating or actions with the listmanagedinstances method. + operationId: compute.instanceGroupManagers.createInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + It should conform to RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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. The request ID must be a valid UUID with + the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersCreateInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Flags the specified instances in the managed instance group for + immediate deletion. The instances are also removed from any target pools of + which they were a member. This method reduces the targetSize of the managed + instance group by the number of instances that you delete. This operation + is marked as DONE when the action is scheduled even if the instances are still + being deleted. You must separately verify the status of the deleting action + with the listmanagedinstances method. If the group is part of a backend service + that has enabled connection draining, it can take up to 60 seconds after the + connection draining duration has elapsed before the VM instance is removed + or deleted. You can specify a maximum of 1000 instances with this method per + request. + operationId: compute.instanceGroupManagers.deleteInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersDeleteInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Deletes selected per-instance configs for the managed instance + group. + operationId: compute.instanceGroupManagers.deletePerInstanceConfigs + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + It should conform to RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersDeletePerInstanceConfigsReq' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors: + get: + description: Lists all errors thrown by actions on instances for a given managed + instance group. The filter and orderBy query parameters are not supported. + operationId: compute.instanceGroupManagers.listErrors + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + It should conform to RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: 'The name of the managed instance group. It must be a string + that meets the requirements in RFC1035, or an unsigned long integer: must + match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.' + in: path + name: instanceGroupManager + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersListErrorsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroupManagers + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists all of the instances in the managed instance group. Each + instance in the list has a currentAction, which indicates the action that + the managed instance group is performing on the instance. For example, if + the group is still creating an instance, the currentAction is CREATING. If + a previous action failed, the list displays the errors for that failed action. + The orderBy query parameter is not supported. + operationId: compute.instanceGroupManagers.listManagedInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersListManagedInstancesResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists all of the per-instance configs defined for the managed instance + group. The orderBy query parameter is not supported. + operationId: compute.instanceGroupManagers.listPerInstanceConfigs + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + It should conform to RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersListPerInstanceConfigsResp' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Inserts or patches per-instance configs for the managed instance + group. perInstanceConfig.name serves as a key used to distinguish whether + to perform insert or patch. + operationId: compute.instanceGroupManagers.patchPerInstanceConfigs + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + It should conform to RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersPatchPerInstanceConfigsReq' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Flags the specified VM instances in the managed instance group + to be immediately recreated. Each instance is recreated using the group's + current configuration. This operation is marked as DONE when the flag is set + even if the instances have not yet been recreated. You must separately verify + the status of each instance by checking its currentAction field; for more + information, see Checking the status of managed instances. If the group is + part of a backend service that has enabled connection draining, it can take + up to 60 seconds after the connection draining duration has elapsed before + the VM instance is removed or deleted. You can specify a maximum of 1000 instances + with this method per request. + operationId: compute.instanceGroupManagers.recreateInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersRecreateInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Resizes the managed instance group. If you increase the size, + the group creates new instances using the current instance template. If you + decrease the size, the group deletes instances. The resize operation is marked + DONE when the resize actions are scheduled even if the group has not yet added + or deleted any instances. You must separately verify the status of the creating + or deleting actions with the listmanagedinstances method. When resizing down, + the instance group arbitrarily chooses the order in which VMs are deleted. + The group takes into account some VM attributes when making the selection + including: + The status of the VM instance. + The health of the VM instance. + + The instance template version the VM is based on. + For regional managed + instance groups, the location of the VM instance. This list is subject to + change. If the group is part of a backend service that has enabled connection + draining, it can take up to 60 seconds after the connection draining duration + has elapsed before the VM instance is removed or deleted.' + operationId: compute.instanceGroupManagers.resize + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - description: The number of running instances that the managed instance group + should maintain at any given time. The group automatically adds or removes + instances to maintain the number of instances specified by this parameter. + in: query + name: size + required: true + schema: + type: integer + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Specifies the instance template to use when creating new instances + in this 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. + operationId: compute.instanceGroupManagers.setInstanceTemplate + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersSetInstanceTemplateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Modifies the target pools to which all instances in this managed + instance group are assigned. The target pools automatically apply to all of + the instances in the managed instance group. This operation is marked DONE + when you make the request even if the instances have not yet been added to + their target pools. The change might take some time to apply to all of the + instances in the group depending on the size of the group. + operationId: compute.instanceGroupManagers.setTargetPools + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersSetTargetPoolsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Inserts or updates per-instance configs for the managed instance + group. perInstanceConfig.name serves as a key used to distinguish whether + to perform insert or patch. + operationId: compute.instanceGroupManagers.updatePerInstanceConfigs + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the managed instance group is located. + It should conform to RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the managed instance group. It should conform to + RFC1035. + in: path + name: instanceGroupManager + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersUpdatePerInstanceConfigsReq' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroupManagers + /projects/{project}/zones/{zone}/instanceGroups: + get: + description: Retrieves the list of zonal instance group resources contained + within the specified zone. For managed instance groups, use the instanceGroupManagers + or regionInstanceGroupManagers methods instead. + operationId: compute.instanceGroups.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates an instance group in the specified project using the parameters + that are included in the request. + operationId: compute.instanceGroups.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where you want to create the instance group. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroups + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}: + delete: + description: Deletes the specified instance group. The instances in the group + are not deleted. Note that instance group must not belong to a backend service. + Read Deleting an instance group for more information. + operationId: compute.instanceGroups.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the instance group to delete. + in: path + name: instanceGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroups + get: + description: Returns the specified zonal instance group. Get a list of available + zonal instance groups by making a list() request. For managed instance groups, + use the instanceGroupManagers or regionInstanceGroupManagers methods instead. + operationId: compute.instanceGroups.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the instance group. + in: path + name: instanceGroup + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroup' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds a list of instances to the specified instance group. All of + the instances in the instance group must be in the same network/subnetwork. + Read Adding instances for more information. + operationId: compute.instanceGroups.addInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the instance group where you are adding instances. + in: path + name: instanceGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupsAddInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroups + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists the instances in the specified instance group. The orderBy + query parameter is not supported. + operationId: compute.instanceGroups.listInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the instance group from which you want to generate + a list of included instances. + in: path + name: instanceGroup + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupsListInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupsListInstances' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instanceGroups + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes one or more instances from the specified instance group, + but does not delete those instances. If the group is part of a backend service + that has enabled connection draining, it can take up to 60 seconds after the + connection draining duration before the VM instance is removed or deleted. + operationId: compute.instanceGroups.removeInstances + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the instance group where the specified instances + will be removed. + in: path + name: instanceGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupsRemoveInstancesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroups + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the named ports for the specified instance group. + operationId: compute.instanceGroups.setNamedPorts + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the instance group is located. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the instance group where the named ports are updated. + in: path + name: instanceGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupsSetNamedPortsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instanceGroups + /projects/{project}/zones/{zone}/instances: + get: + description: Retrieves the list of instances contained within the specified + zone. + operationId: compute.instances.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates an instance resource in the specified project using the + data included in the request. + operationId: compute.instances.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + - description: 'Specifies instance template to create the instance. This field + is optional. It can be a full or partial URL. For example, the following + are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project + /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate + - global/instanceTemplates/instanceTemplate ' + in: query + name: sourceInstanceTemplate + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/bulkInsert: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates multiple instances. Count specifies the number of instances + to create. + operationId: compute.instances.bulkInsert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkInsertInstanceResource' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}: + delete: + description: Deletes the specified Instance resource. For more information, + see Deleting an instance. + operationId: compute.instances.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance resource to delete. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + get: + description: Returns the specified Instance resource. Gets a list of available + instances by making a list() request. + operationId: compute.instances.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance resource to return. + in: path + name: instance + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + put: + description: Updates an instance only if the necessary resources are available. + This method can update only a specific set of instance properties. See Updating + a running instance for a list of updatable instance properties. + operationId: compute.instances.update + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance resource to update. + in: path + name: instance + required: true + schema: + type: string + - description: Specifies the action to take when updating an instance even if + the updated properties do not require it. If not specified, then Compute + Engine acts based on the minimum action that the updated properties require. + in: query + name: minimalAction + schema: + enum: + - INVALID + - NO_EFFECT + - REFRESH + - RESTART + type: string + - description: Specifies the most disruptive action that can be taken on the + instance as part of the update. Compute Engine returns an error if the instance + properties require a more disruptive action as part of the instance update. + Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. + in: query + name: mostDisruptiveAllowedAction + schema: + enum: + - INVALID + - NO_EFFECT + - REFRESH + - RESTART + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds an access config to an instance's network interface. + operationId: compute.instances.addAccessConfig + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - description: The name of the network interface to add to this instance. + in: query + name: networkInterface + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccessConfig' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds existing resource policies to an instance. You can only add + one policy right now which will be applied to this instance for scheduling + live migrations. + operationId: compute.instances.addResourcePolicies + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesAddResourcePoliciesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/attachDisk: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Attaches an existing Disk resource to an instance. You must first + create the disk before you can attach it. It is not possible to create and + attach a disk at the same time. For more information, read Adding a persistent + disk to your instance. + operationId: compute.instances.attachDisk + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - description: Whether to force attach the regional disk even if it's currently + attached to another instance. If you try to force attach a zonal disk to + an instance, you will receive an error. + in: query + name: forceAttach + schema: + type: boolean + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AttachedDisk' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Deletes an access config from an instance's network interface. + operationId: compute.instances.deleteAccessConfig + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - description: The name of the access config to delete. + in: query + name: accessConfig + required: true + schema: + type: string + - description: The name of the network interface. + in: query + name: networkInterface + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/detachDisk: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Detaches a disk from an instance. + operationId: compute.instances.detachDisk + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - description: The device name of the disk to detach. Make a get() request on + the instance to view currently attached disks and device names. + in: query + name: deviceName + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls: + get: + description: Returns effective firewalls applied to an interface of the instance. + operationId: compute.instances.getEffectiveFirewalls + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - description: The name of the network interface to get the effective firewalls. + in: query + name: networkInterface + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesGetEffectiveFirewallsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes: + get: + description: Returns the specified guest attributes entry. + operationId: compute.instances.getGuestAttributes + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - description: Specifies the guest attributes path to be queried. + in: query + name: queryPath + schema: + type: string + - description: Specifies the key for the guest attributes entry. + in: query + name: variableKey + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GuestAttributes' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity: + get: + description: Returns the Shielded Instance Identity of an instance + operationId: compute.instances.getShieldedInstanceIdentity + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ShieldedInstanceIdentity' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instances/{instance}/referrers: + get: + description: Retrieves a list of resources that refer to the VM instance specified + in the request. For example, if the VM instance is part of a managed or unmanaged + instance group, the referrers list includes the instance group. For more information, + read Viewing referrers to VM instances. + operationId: compute.instances.listReferrers + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the target instance scoping this request, or '-' if the + request should span over all instances in the container. + in: path + name: instance + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceListReferrers' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Removes resource policies from an instance. + operationId: compute.instances.removeResourcePolicies + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesRemoveResourcePoliciesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/reset: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Performs a reset on the instance. This is a hard reset the VM does + not do a graceful shutdown. For more information, see Resetting an instance. + operationId: compute.instances.reset + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/screenshot: + get: + description: Returns the screenshot from the specified instance. + operationId: compute.instances.getScreenshot + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Screenshot' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sends diagnostic interrupt to the instance. + operationId: compute.instances.sendDiagnosticInterrupt + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/serialPort: + get: + description: Returns the last 1 MB of serial port output from the specified + instance. + operationId: compute.instances.getSerialPortOutput + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance for this request. + in: path + name: instance + required: true + schema: + type: string + - description: Specifies which COM or serial port to retrieve data from. + in: query + name: port + schema: + maximum: 4 + minimum: 1 + type: integer + - description: Specifies the starting byte position of the output to return. + To start with the first byte of output to the specified port, omit this + field or set it to `0`. If the output for that byte position is available, + this field matches the `start` parameter sent with the request. If the amount + of serial console output exceeds the size of the buffer (1 MB), the oldest + output is discarded and is no longer available. If the requested start position + refers to discarded output, the start position is adjusted to the oldest + output still available, and the adjusted start position is returned as the + `start` property value. You can also provide a negative start position, + which translates to the most recent number of bytes written to the serial + port. For example, -3 is interpreted as the most recent 3 bytes written + to the serial console. + in: query + name: start + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SerialPortOutput' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the auto-delete flag for a disk attached to an instance. + operationId: compute.instances.setDiskAutoDelete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - description: Whether to auto-delete the disk when the instance is deleted. + in: query + name: autoDelete + required: true + schema: + type: boolean + - description: The device name of the disk to modify. Make a get() request on + the instance to view currently attached disks and device names. + in: query + name: deviceName + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets labels on an instance. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.instances.setLabels + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesSetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setMachineResources: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the number and/or type of accelerator for a stopped instance + to the values specified in the request. + operationId: compute.instances.setMachineResources + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesSetMachineResourcesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setMachineType: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the machine type for a stopped instance to the machine + type specified in the request. + operationId: compute.instances.setMachineType + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesSetMachineTypeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setMetadata: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets metadata for the specified instance to the data included in + the request. + operationId: compute.instances.setMetadata + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Metadata' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Changes the minimum CPU platform that this instance should use. + This method can only be called on a stopped instance. For more information, + read Specifying a Minimum CPU Platform. + operationId: compute.instances.setMinCpuPlatform + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesSetMinCpuPlatformRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setScheduling: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets an instance's scheduling options. You can only call this method + on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. + See Instance Life Cycle for more information on the possible instance states. + operationId: compute.instances.setScheduling + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Scheduling' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the service account on the instance. For more information, + read Changing the service account and access scopes for an instance. + operationId: compute.instances.setServiceAccount + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance resource to start. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesSetServiceAccountRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Sets the Shielded Instance integrity policy for an instance. You + can only use this method on a running instance. This method supports PATCH + semantics and uses the JSON merge patch format and processing rules. + operationId: compute.instances.setShieldedInstanceIntegrityPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShieldedInstanceIntegrityPolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/setTags: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets network tags for the specified instance to the data included + in the request. + operationId: compute.instances.setTags + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Tags' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Simulates a maintenance event on the instance. + operationId: compute.instances.simulateMaintenanceEvent + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/start: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Starts an instance that was stopped using the instances().stop + method. For more information, see Restart an instance. + operationId: compute.instances.start + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance resource to start. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Starts an instance that was stopped using the instances().stop + method. For more information, see Restart an instance. + operationId: compute.instances.startWithEncryptionKey + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance resource to start. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesStartWithEncryptionKeyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/stop: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Stops a running instance, shutting it down cleanly, and allows + you to restart the instance at a later time. Stopped instances do not incur + VM usage charges while they are stopped. However, resources that the VM is + using, such as persistent disks and static IP addresses, will continue to + be charged until they are deleted. For more information, see Stopping an instance. + operationId: compute.instances.stop + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance resource to stop. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Updates the specified access config from an instance's network + interface with the data included in the request. This method supports PATCH + semantics and uses the JSON merge patch format and processing rules. + operationId: compute.instances.updateAccessConfig + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - description: The name of the network interface where the access config is + attached. + in: query + name: networkInterface + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccessConfig' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the Display config for a VM instance. You can only use + this method on a stopped VM instance. This method supports PATCH semantics + and uses the JSON merge patch format and processing rules. + operationId: compute.instances.updateDisplayDevice + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisplayDevice' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates an instance's network interface. This method can only update + an interface's alias IP range and attached network. See Modifying alias IP + ranges for an existing instance for instructions on changing alias IP ranges. + See Migrating a VM between networks for instructions on migrating an interface. + This method follows PATCH semantics. + operationId: compute.instances.updateNetworkInterface + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: The instance name for this request. + in: path + name: instance + required: true + schema: + type: string + - description: The name of the network interface to update. + in: query + name: networkInterface + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkInterface' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the Shielded Instance config for an instance. You can only + use this method on a stopped instance. This method supports PATCH semantics + and uses the JSON merge patch format and processing rules. + operationId: compute.instances.updateShieldedInstanceConfig + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the instance scoping this request. + in: path + name: instance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShieldedInstanceConfig' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.instances.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets deletion protection on the instance. + operationId: compute.instances.setDeletionProtection + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Whether the resource should be protected against deletion. + in: query + name: deletionProtection + schema: + type: boolean + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.instances.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - instances + /projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.instances.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - instances + /projects/{project}/zones/{zone}/machineTypes: + get: + description: Retrieves a list of machine types available to the specified project. + operationId: compute.machineTypes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineTypeList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - machineTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/machineTypes/{machineType}: + get: + description: Returns the specified machine type. Gets a list of available machine + types by making a list() request. + operationId: compute.machineTypes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the machine type to return. + in: path + name: machineType + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineType' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - machineTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/networkEndpointGroups: + get: + description: Retrieves the list of network endpoint groups that are located + in the specified project and zone. + operationId: compute.networkEndpointGroups.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networkEndpointGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a network endpoint group in the specified project using + the parameters that are included in the request. + operationId: compute.networkEndpointGroups.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where you want to create the network endpoint + group. It should comply with RFC1035. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networkEndpointGroups + /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}: + delete: + description: Deletes the specified network endpoint group. The network endpoints + in the NEG and the VM instances they belong to are not terminated when the + NEG is deleted. Note that the NEG cannot be deleted if there are backend services + referencing it. + operationId: compute.networkEndpointGroups.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the network endpoint group to delete. It should comply + with RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networkEndpointGroups + get: + description: Returns the specified network endpoint group. Gets a list of available + network endpoint groups by making a list() request. + operationId: compute.networkEndpointGroups.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the network endpoint group. It should comply with + RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroup' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networkEndpointGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Attach a list of network endpoints to the specified network endpoint + group. + operationId: compute.networkEndpointGroups.attachNetworkEndpoints + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the network endpoint group where you are attaching + network endpoints to. It should comply with RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupsAttachEndpointsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networkEndpointGroups + /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Detach a list of network endpoints from the specified network endpoint + group. + operationId: compute.networkEndpointGroups.detachNetworkEndpoints + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: zone + required: true + schema: + type: string + - description: The name of the network endpoint group where you are removing + network endpoints. It should comply with RFC1035. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupsDetachEndpointsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - networkEndpointGroups + /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists the network endpoints in the specified network endpoint group. + operationId: compute.networkEndpointGroups.listNetworkEndpoints + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone where the network endpoint group is located. + It should comply with RFC1035. + in: path + name: zone + required: true + schema: + type: string + - 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. + in: path + name: networkEndpointGroup + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupsListEndpointsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupsListNetworkEndpoints' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networkEndpointGroups + /projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.networkEndpointGroups.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - networkEndpointGroups + /projects/{project}/zones/{zone}/nodeGroups: + get: + description: 'Retrieves a list of node groups available to the specified project. + Note: use nodeGroups.listNodes for more details about each group.' + operationId: compute.nodeGroups.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a NodeGroup resource in the specified project using the + data included in the request. + operationId: compute.nodeGroups.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Initial count of nodes in the node group. + in: query + name: initialNodeCount + required: true + schema: + type: integer + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeGroups + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}: + delete: + description: Deletes the specified NodeGroup resource. + operationId: compute.nodeGroups.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the NodeGroup resource to delete. + in: path + name: nodeGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeGroups + get: + description: 'Returns the specified NodeGroup. Get a list of available NodeGroups + by making a list() request. Note: the "nodes" field should not be used. Use + nodeGroups.listNodes instead.' + operationId: compute.nodeGroups.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the node group to return. + in: path + name: nodeGroup + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroup' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates the specified node group. + operationId: compute.nodeGroups.patch + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the NodeGroup resource to update. + in: path + name: nodeGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeGroups + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Adds specified number of nodes to the node group. + operationId: compute.nodeGroups.addNodes + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the NodeGroup resource. + in: path + name: nodeGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupsAddNodesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeGroups + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Deletes specified nodes from the node group. + operationId: compute.nodeGroups.deleteNodes + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the NodeGroup resource whose nodes will be deleted. + in: path + name: nodeGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupsDeleteNodesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeGroups + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Lists nodes in the node group. + operationId: compute.nodeGroups.listNodes + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the NodeGroup resource whose nodes you want to list. + in: path + name: nodeGroup + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupsListNodes' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeGroups + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Updates the node template of the node group. + operationId: compute.nodeGroups.setNodeTemplate + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the NodeGroup resource to update. + in: path + name: nodeGroup + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupsSetNodeTemplateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeGroups + /projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.nodeGroups.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeGroups + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.nodeGroups.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - nodeGroups + /projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.nodeGroups.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeGroups + /projects/{project}/zones/{zone}/nodeTypes: + get: + description: Retrieves a list of node types available to the specified project. + operationId: compute.nodeTypes.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTypeList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/nodeTypes/{nodeType}: + get: + description: Returns the specified node type. Gets a list of available node + types by making a list() request. + operationId: compute.nodeTypes.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the node type to return. + in: path + name: nodeType + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeType' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - nodeTypes + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/operations: + get: + description: Retrieves a list of Operation resources contained within the specified + zone. + operationId: compute.zoneOperations.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperationList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - zoneOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/operations/{operation}: + delete: + description: Deletes the specified zone-specific Operations resource. + operationId: compute.zoneOperations.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the Operations resource to delete. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - zoneOperations + get: + description: Retrieves the specified zone-specific Operations resource. + operationId: compute.zoneOperations.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the Operations resource to return. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - zoneOperations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/operations/{operation}/wait: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: 'Waits for the specified Operation resource to return as `DONE` + or for the request to approach the 2 minute deadline, and retrieves the specified + Operation resource. This method waits for no more than the 2 minutes and then + returns the current state of the operation, which might be `DONE` or still + in progress. This method is called on a best-effort basis. Specifically: - + In uncommon cases, when the server is overloaded, the request might return + before the default deadline is reached, or might return after zero seconds. + - If the default deadline is reached, there is no guarantee that the operation + is actually done when the method returns. Be prepared to retry if the operation + is not `DONE`. ' + operationId: compute.zoneOperations.wait + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the Operations resource to return. + in: path + name: operation + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - zoneOperations + /projects/{project}/zones/{zone}/reservations: + get: + description: A list of all the reservations that have been configured for the + specified project in specified zone. + operationId: compute.reservations.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ReservationList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - reservations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new reservation. For more information, read Reserving + zonal resources. + operationId: compute.reservations.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Reservation' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - reservations + /projects/{project}/zones/{zone}/reservations/{reservation}: + delete: + description: Deletes the specified reservation. + operationId: compute.reservations.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the reservation to delete. + in: path + name: reservation + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - reservations + get: + description: Retrieves information about the specified reservation. + operationId: compute.reservations.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the reservation to retrieve. + in: path + name: reservation + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Reservation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - reservations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/reservations/{reservation}/resize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Resizes the reservation (applicable to standalone reservations + only). For more information, read Modifying reservations. + operationId: compute.reservations.resize + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the reservation to update. + in: path + name: reservation + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReservationsResizeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - reservations + /projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy: + get: + description: Gets the access control policy for a resource. May be empty if + no such policy or resource exists. + operationId: compute.reservations.getIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + - description: Requested IAM Policy version. + in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - reservations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + /projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. + operationId: compute.reservations.setIamPolicy + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - reservations + /projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.reservations.testIamPermissions + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: The name of the zone for this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name or id of the resource for this request. + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - reservations + /projects/{project}/zones/{zone}/targetInstances: + get: + description: Retrieves a list of TargetInstance resources available to the specified + project and zone. + operationId: compute.targetInstances.list + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone scoping this request. + in: path + name: zone + required: true + schema: + type: string + - description: 'A filter expression that filters resources listed in the response. + The expression must specify the field name, a comparison operator, and the + value that you want to use for filtering. The value must be a string, a + number, or a boolean. The comparison 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`. 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) ```' + in: query + name: filter + schema: + type: string + - 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`)' + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - 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. + in: query + name: orderBy + schema: + type: string + - 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. + in: query + name: pageToken + schema: + type: string + - description: Opt-in for partial success behavior which provides partial results + in case of failure. The default value is false. + in: query + name: returnPartialSuccess + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetInstanceList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetInstances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a TargetInstance resource in the specified project and + zone using the data included in the request. + operationId: compute.targetInstances.insert + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone scoping this request. + in: path + name: zone + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetInstance' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetInstances + /projects/{project}/zones/{zone}/targetInstances/{targetInstance}: + delete: + description: Deletes the specified TargetInstance resource. + operationId: compute.targetInstances.delete + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone scoping this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the TargetInstance resource to delete. + in: path + name: targetInstance + required: true + schema: + type: string + - 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). + in: query + name: requestId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + tags: + - targetInstances + get: + description: Returns the specified TargetInstance resource. Gets a list of available + target instances by making a list() request. + operationId: compute.targetInstances.get + parameters: + - description: Project ID for this request. + in: path + name: project + required: true + schema: + type: string + - description: Name of the zone scoping this request. + in: path + name: zone + required: true + schema: + type: string + - description: Name of the TargetInstance resource to return. + in: path + name: targetInstance + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TargetInstance' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + tags: + - targetInstances + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' +servers: +- url: https://compute.googleapis.com/compute/v1 +tags: +- name: acceleratorTypes +- name: addresses +- name: autoscalers +- name: backendBuckets +- name: backendServices +- name: disks +- name: diskTypes +- name: externalVpnGateways +- name: firewallPolicies +- name: firewalls +- name: forwardingRules +- name: globalAddresses +- name: globalForwardingRules +- name: globalNetworkEndpointGroups +- name: globalOperations +- name: globalOrganizationOperations +- name: globalPublicDelegatedPrefixes +- name: healthChecks +- name: httpHealthChecks +- name: httpsHealthChecks +- name: imageFamilyViews +- name: images +- name: instanceGroupManagers +- name: instanceGroups +- name: instances +- name: instanceTemplates +- name: interconnectAttachments +- name: interconnectLocations +- name: interconnects +- name: licenseCodes +- name: licenses +- name: machineTypes +- name: networkEndpointGroups +- name: networks +- name: nodeGroups +- name: nodeTemplates +- name: nodeTypes +- name: packetMirrorings +- name: projects +- name: publicAdvertisedPrefixes +- name: publicDelegatedPrefixes +- name: regionAutoscalers +- name: regionBackendServices +- name: regionCommitments +- name: regionDisks +- name: regionDiskTypes +- name: regionHealthChecks +- name: regionHealthCheckServices +- name: regionInstanceGroupManagers +- name: regionInstanceGroups +- name: regionInstances +- name: regionNetworkEndpointGroups +- name: regionNotificationEndpoints +- name: regionOperations +- name: regions +- name: regionSslCertificates +- name: regionTargetHttpProxies +- name: regionTargetHttpsProxies +- name: regionUrlMaps +- name: reservations +- name: resourcePolicies +- name: routers +- name: routes +- name: securityPolicies +- name: serviceAttachments +- name: snapshots +- name: sslCertificates +- name: sslPolicies +- name: subnetworks +- name: targetGrpcProxies +- name: targetHttpProxies +- name: targetHttpsProxies +- name: targetInstances +- name: targetPools +- name: targetSslProxies +- name: targetTcpProxies +- name: targetVpnGateways +- name: urlMaps +- name: vpnGateways +- name: vpnTunnels +- name: zoneOperations +- name: zones diff --git a/test/registry/src/googleapis.com/v1/services-split/compute/compute-v1.yaml.sig b/test/registry/src/googleapis.com/v1/services-split/compute/compute-v1.yaml.sig new file mode 100644 index 00000000..9ed8c85f --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services-split/compute/compute-v1.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELaB4JRSAKUIBJEalNw8qeA/xGIogYABxUPEe3n2jAP7+vASvEWSP7zMThl2xLPHiL7/4OUDETFGkr6R5duTN7+um4sSWt9Cg== \ No newline at end of file diff --git a/test/registry/src/googleapis.com/v1/services/bigquery-v2.yaml b/test/registry/src/googleapis.com/v1/services/bigquery-v2.yaml new file mode 100644 index 00000000..ccb5b38b --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services/bigquery-v2.yaml @@ -0,0 +1,8036 @@ +components: + parameters: + alt: + description: Data format for the response. + in: query + name: alt + schema: + enum: + - json + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: API key. Your API key identifies your project and provides you + with API access, quota, and reports. Required unless you provide an OAuth + 2.0 token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: An opaque string that represents a user for quota purposes. Must + not exceed 40 characters. + in: query + name: quotaUser + schema: + type: string + userIp: + description: Deprecated. Please use quotaUser instead. + in: query + name: userIp + schema: + type: string + schemas: + AggregateClassificationMetrics: + description: Aggregate metrics for classification/classifier models. For multi-class + models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, + the metrics are calculated for each label and then an unweighted average is + taken of those values. When micro-averaged, the metric is calculated globally + by counting the total number of correctly predicted rows. + properties: + accuracy: + description: Accuracy is the fraction of predictions given the correct label. + For multiclass this is a micro-averaged metric. + format: double + type: number + f1Score: + description: The F1 score is an average of recall and precision. For multiclass + this is a macro-averaged metric. + format: double + type: number + logLoss: + description: Logarithmic Loss. For multiclass this is a macro-averaged metric. + format: double + type: number + precision: + description: Precision is the fraction of actual positive predictions that + had positive actual labels. For multiclass this is a macro-averaged metric + treating each class as a binary classifier. + format: double + type: number + recall: + description: Recall is the fraction of actual positive labels that were + given a positive prediction. For multiclass this is a macro-averaged metric. + format: double + type: number + rocAuc: + description: Area Under a ROC Curve. For multiclass this is a macro-averaged + metric. + format: double + type: number + threshold: + description: Threshold at which the metrics are computed. For binary classification + models this is the positive class threshold. For multi-class classfication + models this is the confidence threshold. + format: double + type: number + type: object + Argument: + description: Input/output argument of a function or a stored procedure. + properties: + argumentKind: + description: Optional. Defaults to FIXED_TYPE. + enum: + - ARGUMENT_KIND_UNSPECIFIED + - FIXED_TYPE + - ANY_TYPE + type: string + dataType: + $ref: '#/components/schemas/StandardSqlDataType' + description: Required unless argument_kind = ANY_TYPE. + mode: + description: Optional. Specifies whether the argument is input or output. + Can be set for procedures only. + enum: + - MODE_UNSPECIFIED + - IN + - OUT + - INOUT + type: string + name: + description: Optional. The name of this argument. Can be absent for function + return argument. + type: string + type: object + ArimaCoefficients: + description: Arima coefficients. + properties: + autoRegressiveCoefficients: + description: Auto-regressive coefficients, an array of double. + items: + format: double + type: number + type: array + interceptCoefficient: + description: Intercept coefficient, just a double not an array. + format: double + type: number + movingAverageCoefficients: + description: Moving-average coefficients, an array of double. + items: + format: double + type: number + type: array + type: object + ArimaFittingMetrics: + description: ARIMA model fitting metrics. + properties: + aic: + description: AIC. + format: double + type: number + logLikelihood: + description: Log-likelihood. + format: double + type: number + variance: + description: Variance. + format: double + type: number + type: object + ArimaForecastingMetrics: + description: Model evaluation metrics for ARIMA forecasting models. + properties: + arimaFittingMetrics: + description: Arima model fitting metrics. + items: + $ref: '#/components/schemas/ArimaFittingMetrics' + type: array + arimaSingleModelForecastingMetrics: + description: Repeated as there can be many metric sets (one for each model) + in auto-arima and the large-scale case. + items: + $ref: '#/components/schemas/ArimaSingleModelForecastingMetrics' + type: array + hasDrift: + description: Whether Arima model fitted with drift or not. It is always + false when d is not 1. + items: + type: boolean + type: array + nonSeasonalOrder: + description: Non-seasonal order. + items: + $ref: '#/components/schemas/ArimaOrder' + type: array + seasonalPeriods: + description: Seasonal periods. Repeated because multiple periods are supported + for one time series. + items: + enum: + - SEASONAL_PERIOD_TYPE_UNSPECIFIED + - NO_SEASONALITY + - DAILY + - WEEKLY + - MONTHLY + - QUARTERLY + - YEARLY + type: string + type: array + timeSeriesId: + description: Id to differentiate different time series for the large-scale + case. + items: + type: string + type: array + type: object + ArimaModelInfo: + description: Arima model information. + properties: + arimaCoefficients: + $ref: '#/components/schemas/ArimaCoefficients' + description: Arima coefficients. + arimaFittingMetrics: + $ref: '#/components/schemas/ArimaFittingMetrics' + description: Arima fitting metrics. + hasDrift: + description: Whether Arima model fitted with drift or not. It is always + false when d is not 1. + type: boolean + hasHolidayEffect: + description: If true, holiday_effect is a part of time series decomposition + result. + type: boolean + hasSpikesAndDips: + description: If true, spikes_and_dips is a part of time series decomposition + result. + type: boolean + hasStepChanges: + description: If true, step_changes is a part of time series decomposition + result. + type: boolean + nonSeasonalOrder: + $ref: '#/components/schemas/ArimaOrder' + description: Non-seasonal order. + seasonalPeriods: + description: Seasonal periods. Repeated because multiple periods are supported + for one time series. + items: + enum: + - SEASONAL_PERIOD_TYPE_UNSPECIFIED + - NO_SEASONALITY + - DAILY + - WEEKLY + - MONTHLY + - QUARTERLY + - YEARLY + type: string + type: array + timeSeriesId: + description: The time_series_id value for this time series. It will be one + of the unique values from the time_series_id_column specified during ARIMA + model training. Only present when time_series_id_column training option + was used. + type: string + timeSeriesIds: + description: The tuple of time_series_ids identifying this time series. + It will be one of the unique tuples of values present in the time_series_id_columns + specified during ARIMA model training. Only present when time_series_id_columns + training option was used and the order of values here are same as the + order of time_series_id_columns. + items: + type: string + type: array + type: object + ArimaOrder: + description: Arima order, can be used for both non-seasonal and seasonal parts. + properties: + d: + description: Order of the differencing part. + format: int64 + type: string + p: + description: Order of the autoregressive part. + format: int64 + type: string + q: + description: Order of the moving-average part. + format: int64 + type: string + type: object + ArimaResult: + description: (Auto-)arima fitting result. Wrap everything in ArimaResult for + easier refactoring if we want to use model-specific iteration results. + properties: + arimaModelInfo: + description: This message is repeated because there are multiple arima models + fitted in auto-arima. For non-auto-arima model, its size is one. + items: + $ref: '#/components/schemas/ArimaModelInfo' + type: array + seasonalPeriods: + description: Seasonal periods. Repeated because multiple periods are supported + for one time series. + items: + enum: + - SEASONAL_PERIOD_TYPE_UNSPECIFIED + - NO_SEASONALITY + - DAILY + - WEEKLY + - MONTHLY + - QUARTERLY + - YEARLY + type: string + type: array + type: object + ArimaSingleModelForecastingMetrics: + description: Model evaluation metrics for a single ARIMA forecasting model. + properties: + arimaFittingMetrics: + $ref: '#/components/schemas/ArimaFittingMetrics' + description: Arima fitting metrics. + hasDrift: + description: Is arima model fitted with drift or not. It is always false + when d is not 1. + type: boolean + hasHolidayEffect: + description: If true, holiday_effect is a part of time series decomposition + result. + type: boolean + hasSpikesAndDips: + description: If true, spikes_and_dips is a part of time series decomposition + result. + type: boolean + hasStepChanges: + description: If true, step_changes is a part of time series decomposition + result. + type: boolean + nonSeasonalOrder: + $ref: '#/components/schemas/ArimaOrder' + description: Non-seasonal order. + seasonalPeriods: + description: Seasonal periods. Repeated because multiple periods are supported + for one time series. + items: + enum: + - SEASONAL_PERIOD_TYPE_UNSPECIFIED + - NO_SEASONALITY + - DAILY + - WEEKLY + - MONTHLY + - QUARTERLY + - YEARLY + type: string + type: array + timeSeriesId: + description: The time_series_id value for this time series. It will be one + of the unique values from the time_series_id_column specified during ARIMA + model training. Only present when time_series_id_column training option + was used. + type: string + timeSeriesIds: + description: The tuple of time_series_ids identifying this time series. + It will be one of the unique tuples of values present in the time_series_id_columns + specified during ARIMA model training. Only present when time_series_id_columns + training option was used and the order of values here are same as the + order of time_series_id_columns. + items: + type: string + type: array + type: object + AuditConfig: + description: 'Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if any, + are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. + If there are AuditConfigs for both `allServices` and a specific service, the + union of the two AuditConfigs is used for that service: the log_types specified + in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig + are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": + [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" + }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", + "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", + "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, + this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also + exempts jose@example.com from DATA_READ logging, and aliya@example.com from + DATA_WRITE logging.' + properties: + auditLogConfigs: + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/AuditLogConfig' + type: array + service: + description: Specifies a service that will be enabled for audit logging. + For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` + is a special value that covers all services. + type: string + type: object + AuditLogConfig: + description: 'Provides the configuration for logging a type of permissions. + Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": + [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables + ''DATA_READ'' and ''DATA_WRITE'' logging, while exempting jose@example.com + from DATA_READ logging.' + properties: + exemptedMembers: + description: Specifies the identities that do not cause logging for this + type of permission. Follows the same format of Binding.members. + items: + type: string + type: array + logType: + description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + type: string + type: object + AvroOptions: + properties: + useAvroLogicalTypes: + description: '[Optional] If sourceFormat is set to "AVRO", indicates whether + to interpret logical types as the corresponding BigQuery data type (for + example, TIMESTAMP), instead of using the raw type (for example, INTEGER).' + type: boolean + type: object + BiEngineReason: + properties: + code: + default: $(reason.code) + description: '[Output-only] High-level BI Engine reason for partial or disabled + acceleration.' + readOnly: true + type: string + message: + default: $(reason.message) + description: '[Output-only] Free form human-readable reason for partial + or disabled acceleration.' + readOnly: true + type: string + type: object + BiEngineStatistics: + properties: + biEngineMode: + default: $(stats.bi_engine_mode) + description: '[Output-only] Specifies which mode of BI Engine acceleration + was performed (if any).' + readOnly: true + type: string + biEngineReasons: + description: In case of DISABLED or PARTIAL bi_engine_mode, these contain + the explanatory reasons as to why BI Engine could not accelerate. In case + the full query was accelerated, this field is not populated. + items: + $ref: '#/components/schemas/BiEngineReason' + type: array + type: object + BigQueryModelTraining: + properties: + currentIteration: + description: '[Output-only, Beta] Index of current ML training iteration. + Updated during create model query job to show job progress.' + format: int32 + type: integer + expectedTotalIterations: + description: '[Output-only, Beta] Expected number of iterations for the + create model query job specified as num_iterations in the input query. + The actual total number of iterations may be less than this number due + to early stop.' + format: int64 + type: string + type: object + BigtableColumn: + properties: + encoding: + description: '[Optional] The encoding of the values when the type is not + STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric + text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes + family of functions. ''encoding'' can also be set at the column family + level. However, the setting at this level takes precedence if ''encoding'' + is set at both levels.' + type: string + fieldName: + description: '[Optional] If the qualifier is not a valid BigQuery field + identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier + must be provided as the column field name and is used as field name in + queries.' + type: string + onlyReadLatest: + description: '[Optional] If this is set, only the latest version of value + in this column are exposed. ''onlyReadLatest'' can also be set at the + column family level. However, the setting at this level takes precedence + if ''onlyReadLatest'' is set at both levels.' + type: boolean + qualifierEncoded: + description: '[Required] Qualifier of the column. Columns in the parent + column family that has this exact qualifier are exposed as . field. If + the qualifier is valid UTF-8 string, it can be specified in the qualifier_string + field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. + The column field name is the same as the column qualifier. However, if + the qualifier is not a valid BigQuery field identifier i.e. does not match + [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.' + format: byte + type: string + qualifierString: + type: string + type: + description: '[Optional] The type to convert the value in cells of this + column. The values are expected to be encoded using HBase Bytes.toBytes + function when using the BINARY encoding value. Following BigQuery types + are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default + type is BYTES. ''type'' can also be set at the column family level. However, + the setting at this level takes precedence if ''type'' is set at both + levels.' + type: string + required: + - qualifierEncoded + type: object + BigtableColumnFamily: + properties: + columns: + description: '[Optional] Lists of columns that should be exposed as individual + fields as opposed to a list of (column name, value) pairs. All columns + whose qualifier matches a qualifier in this list can be accessed as .. + Other columns can be accessed as a list through .Column field.' + items: + $ref: '#/components/schemas/BigtableColumn' + type: array + encoding: + description: '[Optional] The encoding of the values when the type is not + STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric + text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes + family of functions. This can be overridden for a specific column by listing + that column in ''columns'' and specifying an encoding for it.' + type: string + familyId: + description: Identifier of the column family. + type: string + onlyReadLatest: + description: '[Optional] If this is set only the latest version of value + are exposed for all columns in this column family. This can be overridden + for a specific column by listing that column in ''columns'' and specifying + a different setting for that column.' + type: boolean + type: + description: '[Optional] The type to convert the value in cells of this + column family. The values are expected to be encoded using HBase Bytes.toBytes + function when using the BINARY encoding value. Following BigQuery types + are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default + type is BYTES. This can be overridden for a specific column by listing + that column in ''columns'' and specifying a type for it.' + type: string + type: object + BigtableOptions: + properties: + columnFamilies: + description: '[Optional] List of column families to expose in the table + schema along with their types. This list restricts the column families + that can be referenced in queries and specifies their value types. You + can use this list to do type conversions - see the ''type'' field for + more details. If you leave this list empty, all column families are present + in the table schema and their values are read as BYTES. During a query + only the column families referenced in that query are read from Bigtable.' + items: + $ref: '#/components/schemas/BigtableColumnFamily' + type: array + ignoreUnspecifiedColumnFamilies: + description: '[Optional] If field is true, then the column families that + are not specified in columnFamilies list are not exposed in the table + schema. Otherwise, they are read with BYTES type values. The default value + is false.' + type: boolean + readRowkeyAsString: + description: '[Optional] If field is true, then the rowkey column families + will be read and converted to string. Otherwise they are read with BYTES + type values and users need to manually cast them with CAST if necessary. + The default value is false.' + type: boolean + type: object + BinaryClassificationMetrics: + description: Evaluation metrics for binary classification/classifier models. + properties: + aggregateClassificationMetrics: + $ref: '#/components/schemas/AggregateClassificationMetrics' + description: Aggregate classification metrics. + binaryConfusionMatrixList: + description: Binary confusion matrix at multiple thresholds. + items: + $ref: '#/components/schemas/BinaryConfusionMatrix' + type: array + negativeLabel: + description: Label representing the negative class. + type: string + positiveLabel: + description: Label representing the positive class. + type: string + type: object + BinaryConfusionMatrix: + description: Confusion matrix for binary classification models. + properties: + accuracy: + description: The fraction of predictions given the correct label. + format: double + type: number + f1Score: + description: The equally weighted average of recall and precision. + format: double + type: number + falseNegatives: + description: Number of false samples predicted as false. + format: int64 + type: string + falsePositives: + description: Number of false samples predicted as true. + format: int64 + type: string + positiveClassThreshold: + description: Threshold value used when computing each of the following metric. + format: double + type: number + precision: + description: The fraction of actual positive predictions that had positive + actual labels. + format: double + type: number + recall: + description: The fraction of actual positive labels that were given a positive + prediction. + format: double + type: number + trueNegatives: + description: Number of true samples predicted as false. + format: int64 + type: string + truePositives: + description: Number of true samples predicted as true. + format: int64 + type: string + type: object + Binding: + description: Associates `members`, or principals, with a `role`. + properties: + condition: + $ref: '#/components/schemas/Expr' + description: The condition that is associated with this binding. If the + condition evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding does + not apply to the current request. However, a different role binding might + grant the same role to one or more of the principals in this binding. + To learn which resources support conditions in their IAM policies, see + the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + members: + description: 'Specifies the principals requesting access for a Cloud Platform + resource. `members` can have the following values: * `allUsers`: A special + identifier that represents anyone who is on the internet; with or without + a Google account. * `allAuthenticatedUsers`: A special identifier that + represents anyone who is authenticated with a Google account or a service + account. * `user:{emailid}`: An email address that represents a specific + Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: + An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. + * `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a user that has + been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and the + recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a service account + that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` + and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google group + that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. + If the group is recovered, this value reverts to `group:{emailid}` and + the recovered group retains the role in the binding. * `domain:{domain}`: + The G Suite domain (primary) that represents all the users of that domain. + For example, `google.com` or `example.com`. ' + items: + type: string + type: array + role: + description: Role that is assigned to the list of `members`, or principals. + For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + type: string + type: object + BqmlIterationResult: + properties: + durationMs: + description: '[Output-only, Beta] Time taken to run the training iteration + in milliseconds.' + format: int64 + type: string + evalLoss: + description: '[Output-only, Beta] Eval loss computed on the eval data at + the end of the iteration. The eval loss is used for early stopping to + avoid overfitting. No eval loss if eval_split_method option is specified + as no_split or auto_split with input data size less than 500 rows.' + format: double + type: number + index: + description: '[Output-only, Beta] Index of the ML training iteration, starting + from zero for each training run.' + format: int32 + type: integer + learnRate: + description: '[Output-only, Beta] Learning rate used for this iteration, + it varies for different training iterations if learn_rate_strategy option + is not constant.' + format: double + type: number + trainingLoss: + description: '[Output-only, Beta] Training loss computed on the training + data at the end of the iteration. The training loss function is defined + by model type.' + format: double + type: number + type: object + BqmlTrainingRun: + properties: + iterationResults: + description: '[Output-only, Beta] List of each iteration results.' + items: + $ref: '#/components/schemas/BqmlIterationResult' + type: array + startTime: + description: '[Output-only, Beta] Training run start time in milliseconds + since the epoch.' + format: date-time + type: string + state: + description: '[Output-only, Beta] Different state applicable for a training + run. IN PROGRESS: Training run is in progress. FAILED: Training run ended + due to a non-retryable failure. SUCCEEDED: Training run successfully completed. + CANCELLED: Training run cancelled by the user.' + type: string + trainingOptions: + description: '[Output-only, Beta] Training options used by this training + run. These options are mutable for subsequent training runs. Default values + are explicitly stored for options not specified in the input query of + the first training run. For subsequent training runs, any option not explicitly + specified in the input query will be copied from the previous training + run.' + properties: + earlyStop: + type: boolean + l1Reg: + format: double + type: number + l2Reg: + format: double + type: number + learnRate: + format: double + type: number + learnRateStrategy: + type: string + lineSearchInitLearnRate: + format: double + type: number + maxIteration: + format: int64 + type: string + minRelProgress: + format: double + type: number + warmStart: + type: boolean + type: object + type: object + CategoricalValue: + description: Representative value of a categorical feature. + properties: + categoryCounts: + description: Counts of all categories for the categorical feature. If there + are more than ten categories, we return top ten (by count) and return + one more CategoryCount with category "_OTHER_" and count as aggregate + counts of remaining categories. + items: + $ref: '#/components/schemas/CategoryCount' + type: array + type: object + CategoryCount: + description: Represents the count of a single category within the cluster. + properties: + category: + description: The name of category. + type: string + count: + description: The count of training samples matching the category within + the cluster. + format: int64 + type: string + type: object + Cluster: + description: Message containing the information about one cluster. + properties: + centroidId: + description: Centroid id. + format: int64 + type: string + count: + description: Count of training data rows that were assigned to this cluster. + format: int64 + type: string + featureValues: + description: Values of highly variant features for this cluster. + items: + $ref: '#/components/schemas/FeatureValue' + type: array + type: object + ClusterInfo: + description: Information about a single cluster for clustering model. + properties: + centroidId: + description: Centroid id. + format: int64 + type: string + clusterRadius: + description: Cluster radius, the average distance from centroid to each + point assigned to the cluster. + format: double + type: number + clusterSize: + description: Cluster size, the total number of points assigned to the cluster. + format: int64 + type: string + type: object + Clustering: + properties: + fields: + description: '[Repeated] One or more fields on which data should be clustered. + Only top-level, non-repeated, simple-type fields are supported. When you + cluster a table using multiple columns, the order of columns you specify + is important. The order of the specified columns determines the sort order + of the data.' + items: + type: string + type: array + type: object + ClusteringMetrics: + description: Evaluation metrics for clustering models. + properties: + clusters: + description: Information for all clusters. + items: + $ref: '#/components/schemas/Cluster' + type: array + daviesBouldinIndex: + description: Davies-Bouldin index. + format: double + type: number + meanSquaredDistance: + description: Mean of squared distances between each sample to its cluster + centroid. + format: double + type: number + type: object + ConfusionMatrix: + description: Confusion matrix for multi-class classification models. + properties: + confidenceThreshold: + description: Confidence threshold used when computing the entries of the + confusion matrix. + format: double + type: number + rows: + description: One row per actual label. + items: + $ref: '#/components/schemas/Row' + type: array + type: object + ConnectionProperty: + properties: + key: + description: '[Required] Name of the connection property to set.' + type: string + value: + description: '[Required] Value of the connection property.' + type: string + required: + - key + - value + type: object + CsvOptions: + properties: + allowJaggedRows: + description: '[Optional] Indicates if BigQuery should accept rows that are + missing trailing optional columns. If true, BigQuery treats missing trailing + columns as null values. If false, records with missing trailing columns + are treated as bad records, and if there are too many bad records, an + invalid error is returned in the job result. The default value is false.' + type: boolean + allowQuotedNewlines: + description: '[Optional] Indicates if BigQuery should allow quoted data + sections that contain newline characters in a CSV file. The default value + is false.' + type: boolean + encoding: + description: '[Optional] The character encoding of the data. The supported + values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes + the data after the raw, binary data has been split using the values of + the quote and fieldDelimiter properties.' + type: string + fieldDelimiter: + description: '[Optional] The separator for fields in a CSV file. BigQuery + converts the string to ISO-8859-1 encoding, and then uses the first byte + of the encoded string to split the data in its raw, binary state. BigQuery + also supports the escape sequence "\t" to specify a tab separator. The + default value is a comma ('','').' + type: string + null_marker: + description: '[Optional] An custom string that will represent a NULL value + in CSV import data.' + type: string + quote: + default: '"' + description: '[Optional] The value that is used to quote data sections in + a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then + uses the first byte of the encoded string to split the data in its raw, + binary state. The default value is a double-quote (''"''). If your data + does not contain quoted sections, set the property value to an empty string. + If your data contains quoted newline characters, you must also set the + allowQuotedNewlines property to true.' + pattern: .? + type: string + skipLeadingRows: + description: '[Optional] The number of rows at the top of a CSV file that + BigQuery will skip when reading the data. The default value is 0. This + property is useful if you have header rows in the file that should be + skipped. When autodetect is on, the behavior is the following: * skipLeadingRows + unspecified - Autodetect tries to detect headers in the first row. If + they are not detected, the row is read as data. Otherwise data is read + starting from the second row. * skipLeadingRows is 0 - Instructs autodetect + that there are no headers and data should be read starting from the first + row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to + detect headers in row N. If headers are not detected, row N is just skipped. + Otherwise row N is used to extract column names for the detected schema.' + format: int64 + type: string + type: object + DataSplitResult: + description: Data split result. This contains references to the training and + evaluation data tables that were used to train the model. + properties: + evaluationTable: + $ref: '#/components/schemas/TableReference' + description: Table reference of the evaluation data after split. + trainingTable: + $ref: '#/components/schemas/TableReference' + description: Table reference of the training data after split. + type: object + Dataset: + properties: + access: + description: '[Optional] An array of objects that define dataset access + for one or more entities. You can set this property when inserting or + updating a dataset in order to control who is allowed to access the data. + If unspecified at dataset creation time, BigQuery adds default dataset + access for the following entities: access.specialGroup: projectReaders; + access.role: READER; access.specialGroup: projectWriters; access.role: + WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: + [dataset creator email]; access.role: OWNER;' + items: + properties: + dataset: + $ref: '#/components/schemas/DatasetAccessEntry' + description: '[Pick one] A grant authorizing all resources of a particular + type in a particular dataset access to this dataset. Only views + are supported for now. The role field is not required when this + field is set. If that dataset is deleted and re-created, its access + needs to be granted again via an update operation.' + domain: + description: '[Pick one] A domain to grant access to. Any users signed + in with the domain specified will be granted the specified access. + Example: "example.com". Maps to IAM policy member "domain:DOMAIN".' + type: string + groupByEmail: + description: '[Pick one] An email address of a Google Group to grant + access to. Maps to IAM policy member "group:GROUP".' + type: string + iamMember: + description: '[Pick one] Some other type of member that appears in + the IAM Policy but isn''t a user, group, domain, or special group.' + type: string + role: + description: '[Required] An IAM role ID that should be granted to + the user, group, or domain specified in this access entry. The following + legacy mappings will be applied: OWNER roles/bigquery.dataOwner + WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer + This field will accept any of the above formats, but will return + only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", + it will be returned back as "OWNER".' + type: string + routine: + $ref: '#/components/schemas/RoutineReference' + description: '[Pick one] A routine from a different dataset to grant + access to. Queries executed against that routine will have read + access to views/tables/routines in this dataset. Only UDF is supported + for now. The role field is not required when this field is set. + If that routine is updated by any user, access to the routine needs + to be granted again via an update operation.' + specialGroup: + description: '[Pick one] A special group to grant access to. Possible + values include: projectOwners: Owners of the enclosing project. + projectReaders: Readers of the enclosing project. projectWriters: + Writers of the enclosing project. allAuthenticatedUsers: All authenticated + BigQuery users. Maps to similarly-named IAM members.' + type: string + userByEmail: + description: '[Pick one] An email address of a user to grant access + to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" + or "serviceAccount:EMAIL".' + type: string + view: + $ref: '#/components/schemas/TableReference' + description: '[Pick one] A view from a different dataset to grant + access to. Queries executed against that view will have read access + to tables in this dataset. The role field is not required when this + field is set. If that view is updated by any user, access to the + view needs to be granted again via an update operation.' + type: object + type: array + creationTime: + description: '[Output-only] The time when this dataset was created, in milliseconds + since the epoch.' + format: int64 + readOnly: true + type: string + datasetReference: + $ref: '#/components/schemas/DatasetReference' + description: '[Required] A reference that identifies the dataset.' + defaultCollation: + description: '[Output-only] The default collation of the dataset.' + readOnly: true + type: string + defaultEncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + defaultPartitionExpirationMs: + description: '[Optional] The default partition expiration for all partitioned + tables in the dataset, in milliseconds. Once this property is set, all + newly-created partitioned tables in the dataset will have an expirationMs + property in the timePartitioning settings set to this value, and changing + the value will only affect new tables, not existing ones. The storage + in a partition will have an expiration time of its partition time plus + this value. Setting this property overrides the use of defaultTableExpirationMs + for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs + will be used for any new partitioned table. If you provide an explicit + timePartitioning.expirationMs when creating or updating a partitioned + table, that value takes precedence over the default partition expiration + time indicated by this property.' + format: int64 + type: string + defaultTableExpirationMs: + description: '[Optional] The default lifetime of all tables in the dataset, + in milliseconds. The minimum value is 3600000 milliseconds (one hour). + Once this property is set, all newly-created tables in the dataset will + have an expirationTime property set to the creation time plus the value + in this property, and changing the value will only affect new tables, + not existing ones. When the expirationTime for a given table is reached, + that table will be deleted automatically. If a table''s expirationTime + is modified or removed before the table expires, or if you provide an + explicit expirationTime when creating a table, that value takes precedence + over the default expiration time indicated by this property.' + format: int64 + type: string + description: + description: '[Optional] A user-friendly description of the dataset.' + type: string + etag: + description: '[Output-only] A hash of the resource.' + readOnly: true + type: string + friendlyName: + description: '[Optional] A descriptive name for the dataset.' + type: string + id: + description: '[Output-only] The fully-qualified unique name of the dataset + in the format projectId:datasetId. The dataset name without the project + name is given in the datasetId field. When creating a new dataset, leave + this field blank, and instead specify the datasetId field.' + readOnly: true + type: string + isCaseInsensitive: + description: '[Optional] Indicates if table names are case insensitive in + the dataset.' + type: boolean + kind: + default: bigquery#dataset + description: '[Output-only] The resource type.' + readOnly: true + type: string + labels: + additionalProperties: + type: string + description: The labels associated with this dataset. You can use these + to organize and group your datasets. You can set this property when inserting + or updating a dataset. See Creating and Updating Dataset Labels for more + information. + type: object + lastModifiedTime: + description: '[Output-only] The date when this dataset or any of its tables + was last modified, in milliseconds since the epoch.' + format: int64 + readOnly: true + type: string + location: + description: The geographic location where the dataset should reside. The + default value is US. See details at https://cloud.google.com/bigquery/docs/locations. + type: string + satisfiesPZS: + description: '[Output-only] Reserved for future use.' + readOnly: true + type: boolean + selfLink: + description: '[Output-only] A URL that can be used to access the resource + again. You can use this URL in Get or Update requests to the resource.' + readOnly: true + type: string + required: + - datasetReference + type: object + DatasetAccessEntry: + properties: + dataset: + $ref: '#/components/schemas/DatasetReference' + description: '[Required] The dataset this entry applies to.' + target_types: + items: + properties: + targetType: + description: '[Required] Which resources in the dataset this entry + applies to. Currently, only views are supported, but additional + target types may be added in the future. Possible values: VIEWS: + This entry applies to all views in the dataset.' + type: string + type: object + type: array + required: + - dataset + type: object + DatasetList: + properties: + datasets: + description: 'An array of the dataset resources in the project. Each resource + contains basic information. For full information about a particular dataset + resource, use the Datasets: get method. This property is omitted when + there are no datasets in the project.' + items: + properties: + datasetReference: + $ref: '#/components/schemas/DatasetReference' + description: The dataset reference. Use this property to access specific + parts of the dataset's ID, such as project ID or dataset ID. + friendlyName: + description: A descriptive name for the dataset, if one exists. + type: string + id: + description: The fully-qualified, unique, opaque ID of the dataset. + type: string + kind: + default: bigquery#dataset + description: The resource type. This property always returns the value + "bigquery#dataset". + type: string + labels: + additionalProperties: + type: string + description: The labels associated with this dataset. You can use + these to organize and group your datasets. + type: object + location: + description: The geographic location where the data resides. + type: string + type: object + type: array + etag: + description: A hash value of the results page. You can use this property + to determine if the page has changed since the last request. + type: string + kind: + default: bigquery#datasetList + description: The list type. This property always returns the value "bigquery#datasetList". + type: string + nextPageToken: + description: A token that can be used to request the next results page. + This property is omitted on the final results page. + type: string + type: object + DatasetReference: + properties: + datasetId: + description: '[Required] A unique ID for this dataset, without the project + name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores + (_). The maximum length is 1,024 characters.' + type: string + projectId: + description: '[Optional] The ID of the project containing this dataset.' + type: string + required: + - datasetId + type: object + DestinationTableProperties: + properties: + description: + description: '[Optional] The description for the destination table. This + will only be used if the destination table is newly created. If the table + already exists and a value different than the current description is provided, + the job will fail.' + type: string + expirationTime: + description: '[Optional] The destination table expiration time. If this + field is set: For a new table, it will set the table''s expiration time + (even if there is a dataset level default table expiration time). For + an existing table, it will update the table''s expiration time. If this + field is not set: For a new table, if dataset level default table expiration + time is present, that will be applied. For an existing table, no change + is made to the table''s expiration time. Additionally this field is only + applied when data is written to an empty table (WRITE_EMPTY) or data is + overwritten to a table (WRITE_TRUNCATE).' + format: date-time + type: string + friendlyName: + description: '[Optional] The friendly name for the destination table. This + will only be used if the destination table is newly created. If the table + already exists and a value different than the current friendly name is + provided, the job will fail.' + type: string + labels: + additionalProperties: + type: string + description: '[Optional] The labels associated with this table. You can + use these to organize and group your tables. This will only be used if + the destination table is newly created. If the table already exists and + labels are different than the current labels are provided, the job will + fail.' + type: object + type: object + DmlStatistics: + properties: + deletedRowCount: + description: Number of deleted Rows. populated by DML DELETE, MERGE and + TRUNCATE statements. + format: int64 + type: string + insertedRowCount: + description: Number of inserted Rows. Populated by DML INSERT and MERGE + statements. + format: int64 + type: string + updatedRowCount: + description: Number of updated Rows. Populated by DML UPDATE and MERGE statements. + format: int64 + type: string + type: object + EncryptionConfiguration: + properties: + kmsKeyName: + description: '[Optional] Describes the Cloud KMS encryption key that will + be used to protect destination BigQuery table. The BigQuery Service Account + associated with your project requires access to this encryption key.' + type: string + type: object + Entry: + description: A single entry in the confusion matrix. + properties: + itemCount: + description: Number of items being predicted as this label. + format: int64 + type: string + predictedLabel: + description: The predicted label. For confidence_threshold > 0, we will + also add an entry indicating the number of items under the confidence + threshold. + type: string + type: object + ErrorProto: + properties: + debugInfo: + description: Debugging information. This property is internal to Google + and should not be used. + type: string + location: + description: Specifies where the error occurred, if present. + type: string + message: + description: A human-readable description of the error. + type: string + reason: + description: A short error code that summarizes the error. + type: string + type: object + EvaluationMetrics: + description: Evaluation metrics of a model. These are either computed on all + training data or just the eval data based on whether eval data was used during + training. These are not present for imported models. + properties: + arimaForecastingMetrics: + $ref: '#/components/schemas/ArimaForecastingMetrics' + description: Populated for ARIMA models. + binaryClassificationMetrics: + $ref: '#/components/schemas/BinaryClassificationMetrics' + description: Populated for binary classification/classifier models. + clusteringMetrics: + $ref: '#/components/schemas/ClusteringMetrics' + description: Populated for clustering models. + multiClassClassificationMetrics: + $ref: '#/components/schemas/MultiClassClassificationMetrics' + description: Populated for multi-class classification/classifier models. + rankingMetrics: + $ref: '#/components/schemas/RankingMetrics' + description: Populated for implicit feedback type matrix factorization models. + regressionMetrics: + $ref: '#/components/schemas/RegressionMetrics' + description: Populated for regression models and explicit feedback type + matrix factorization models. + type: object + ExplainQueryStage: + properties: + completedParallelInputs: + description: Number of parallel input segments completed. + format: int64 + type: string + computeMsAvg: + description: Milliseconds the average shard spent on CPU-bound tasks. + format: int64 + type: string + computeMsMax: + description: Milliseconds the slowest shard spent on CPU-bound tasks. + format: int64 + type: string + computeRatioAvg: + description: Relative amount of time the average shard spent on CPU-bound + tasks. + format: double + type: number + computeRatioMax: + description: Relative amount of time the slowest shard spent on CPU-bound + tasks. + format: double + type: number + endMs: + description: Stage end time represented as milliseconds since epoch. + format: int64 + type: string + id: + description: Unique ID for stage within plan. + format: int64 + type: string + inputStages: + description: IDs for stages that are inputs to this stage. + items: + format: int64 + type: string + type: array + name: + description: Human-readable name for stage. + type: string + parallelInputs: + description: Number of parallel input segments to be processed. + format: int64 + type: string + readMsAvg: + description: Milliseconds the average shard spent reading input. + format: int64 + type: string + readMsMax: + description: Milliseconds the slowest shard spent reading input. + format: int64 + type: string + readRatioAvg: + description: Relative amount of time the average shard spent reading input. + format: double + type: number + readRatioMax: + description: Relative amount of time the slowest shard spent reading input. + format: double + type: number + recordsRead: + description: Number of records read into the stage. + format: int64 + type: string + recordsWritten: + description: Number of records written by the stage. + format: int64 + type: string + shuffleOutputBytes: + description: Total number of bytes written to shuffle. + format: int64 + type: string + shuffleOutputBytesSpilled: + description: Total number of bytes written to shuffle and spilled to disk. + format: int64 + type: string + slotMs: + description: Slot-milliseconds used by the stage. + format: int64 + type: string + startMs: + description: Stage start time represented as milliseconds since epoch. + format: int64 + type: string + status: + description: Current status for the stage. + type: string + steps: + description: List of operations within the stage in dependency order (approximately + chronological). + items: + $ref: '#/components/schemas/ExplainQueryStep' + type: array + waitMsAvg: + description: Milliseconds the average shard spent waiting to be scheduled. + format: int64 + type: string + waitMsMax: + description: Milliseconds the slowest shard spent waiting to be scheduled. + format: int64 + type: string + waitRatioAvg: + description: Relative amount of time the average shard spent waiting to + be scheduled. + format: double + type: number + waitRatioMax: + description: Relative amount of time the slowest shard spent waiting to + be scheduled. + format: double + type: number + writeMsAvg: + description: Milliseconds the average shard spent on writing output. + format: int64 + type: string + writeMsMax: + description: Milliseconds the slowest shard spent on writing output. + format: int64 + type: string + writeRatioAvg: + description: Relative amount of time the average shard spent on writing + output. + format: double + type: number + writeRatioMax: + description: Relative amount of time the slowest shard spent on writing + output. + format: double + type: number + type: object + ExplainQueryStep: + properties: + kind: + description: Machine-readable operation type. + type: string + substeps: + description: Human-readable stage descriptions. + items: + type: string + type: array + 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.' + 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 + ExternalDataConfiguration: + properties: + autodetect: + description: Try to detect schema and format options automatically. Any + option specified explicitly will be honored. + type: boolean + avroOptions: + $ref: '#/components/schemas/AvroOptions' + description: Additional properties to set if sourceFormat is set to Avro. + bigtableOptions: + $ref: '#/components/schemas/BigtableOptions' + description: '[Optional] Additional options if sourceFormat is set to BIGTABLE.' + compression: + description: '[Optional] The compression type of the data source. Possible + values include GZIP and NONE. The default value is NONE. This setting + is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and + Avro formats.' + type: string + connectionId: + description: '[Optional, Trusted Tester] Connection for external data source.' + type: string + csvOptions: + $ref: '#/components/schemas/CsvOptions' + description: Additional properties to set if sourceFormat is set to CSV. + decimalTargetTypes: + description: '[Optional] Defines the list of possible SQL data types to + which the source decimal values are converted. This list and the precision + and the scale parameters of the decimal field determine the target type. + In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it + is in the specified list and if it supports the precision and the scale. + STRING supports all precision and scale values. If none of the listed + types supports the precision and the scale, the type supporting the widest + range in the specified list is picked, and if a value exceeds the supported + range when reading the data, an error will be thrown. Example: Suppose + the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) + is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer + digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); + (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported + range). This field cannot contain duplicate types. The order of the types + in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the + same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence + over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] + for the other file formats.' + items: + type: string + type: array + googleSheetsOptions: + $ref: '#/components/schemas/GoogleSheetsOptions' + description: '[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.' + hivePartitioningOptions: + $ref: '#/components/schemas/HivePartitioningOptions' + description: '[Optional] Options to configure hive partitioning support.' + ignoreUnknownValues: + description: '[Optional] Indicates if BigQuery should allow extra values + that are not represented in the table schema. If true, the extra values + are ignored. If false, records with extra columns are treated as bad records, + and if there are too many bad records, an invalid error is returned in + the job result. The default value is false. The sourceFormat property + determines what BigQuery treats as an extra value: CSV: Trailing columns + JSON: Named values that don''t match any column names Google Cloud Bigtable: + This setting is ignored. Google Cloud Datastore backups: This setting + is ignored. Avro: This setting is ignored.' + type: boolean + maxBadRecords: + description: '[Optional] The maximum number of bad records that BigQuery + can ignore when reading data. If the number of bad records exceeds this + value, an invalid error is returned in the job result. This is only valid + for CSV, JSON, and Google Sheets. The default value is 0, which requires + that all records are valid. This setting is ignored for Google Cloud Bigtable, + Google Cloud Datastore backups and Avro formats.' + format: int32 + type: integer + parquetOptions: + $ref: '#/components/schemas/ParquetOptions' + description: Additional properties to set if sourceFormat is set to Parquet. + schema: + $ref: '#/components/schemas/TableSchema' + description: '[Optional] The schema for the data. Schema is required for + CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, + Cloud Datastore backups, and Avro formats.' + sourceFormat: + description: '[Required] The data format. For CSV files, specify "CSV". + For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, + specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For + Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For + Google Cloud Bigtable, specify "BIGTABLE".' + type: string + sourceUris: + description: '[Required] The fully-qualified URIs that point to your data + in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one + ''*'' wildcard character and it must come after the ''bucket'' name. Size + limits related to load jobs apply to external data sources. For Google + Cloud Bigtable URIs: Exactly one URI can be specified and it has be a + fully specified and valid HTTPS URL for a Google Cloud Bigtable table. + For Google Cloud Datastore backups, exactly one URI can be specified. + Also, the ''*'' wildcard character is not allowed.' + items: + type: string + type: array + required: + - sourceFormat + - sourceUris + type: object + FeatureValue: + description: Representative value of a single feature within the cluster. + properties: + categoricalValue: + $ref: '#/components/schemas/CategoricalValue' + description: The categorical feature value. + featureColumn: + description: The feature column name. + type: string + numericalValue: + description: The numerical feature value. This is the centroid value for + this feature. + format: double + type: number + type: object + GetIamPolicyRequest: + description: Request message for `GetIamPolicy` method. + properties: + options: + $ref: '#/components/schemas/GetPolicyOptions' + description: 'OPTIONAL: A `GetPolicyOptions` object for specifying options + to `GetIamPolicy`.' + type: object + GetPolicyOptions: + description: Encapsulates settings provided to GetIamPolicy. + properties: + requestedPolicyVersion: + description: Optional. The policy format version to be returned. Valid values + are 0, 1, and 3. Requests specifying an invalid value will be rejected. + Requests for policies with any conditional bindings must specify version + 3. Policies without any conditional bindings may specify any valid value + or leave the field unset. To learn which resources support conditions + in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + format: int32 + type: integer + type: object + GetQueryResultsResponse: + properties: + cacheHit: + description: Whether the query result was fetched from the query cache. + type: boolean + errors: + description: '[Output-only] The first errors or warnings encountered during + the running of the job. The final message includes the number of errors + that caused the process to stop. Errors here do not necessarily mean that + the job has completed or was unsuccessful.' + items: + $ref: '#/components/schemas/ErrorProto' + readOnly: true + type: array + etag: + description: A hash of this response. + type: string + jobComplete: + description: Whether the query has completed or not. If rows or totalRows + are present, this will always be true. If this is false, totalRows will + not be available. + type: boolean + jobReference: + $ref: '#/components/schemas/JobReference' + description: Reference to the BigQuery Job that was created to run the query. + This field will be present even if the original request timed out, in + which case GetQueryResults can be used to read the results once the query + has completed. Since this API only returns the first page of results, + subsequent pages can be fetched via the same mechanism (GetQueryResults). + kind: + default: bigquery#getQueryResultsResponse + description: The resource type of the response. + type: string + numDmlAffectedRows: + description: '[Output-only] The number of rows affected by a DML statement. + Present only for DML statements INSERT, UPDATE or DELETE.' + format: int64 + readOnly: true + type: string + pageToken: + description: A token used for paging results. + type: string + rows: + description: An object with as many results as can be contained within the + maximum permitted reply size. To get any additional rows, you can call + GetQueryResults and specify the jobReference returned above. Present only + when the query completes successfully. + items: + $ref: '#/components/schemas/TableRow' + type: array + schema: + $ref: '#/components/schemas/TableSchema' + description: The schema of the results. Present only when the query completes + successfully. + totalBytesProcessed: + description: The total number of bytes processed for this query. + format: int64 + type: string + totalRows: + description: The total number of rows in the complete query result set, + which can be more than the number of rows in this single page of results. + Present only when the query completes successfully. + format: uint64 + type: string + type: object + GetServiceAccountResponse: + properties: + email: + description: The service account email address. + type: string + kind: + default: bigquery#getServiceAccountResponse + description: The resource type of the response. + type: string + type: object + GoogleSheetsOptions: + properties: + range: + description: '[Optional] Range of a sheet to query from. Only used when + non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id + For example: sheet1!A1:B20' + type: string + skipLeadingRows: + description: '[Optional] The number of rows at the top of a sheet that BigQuery + will skip when reading the data. The default value is 0. This property + is useful if you have header rows that should be skipped. When autodetect + is on, behavior is the following: * skipLeadingRows unspecified - Autodetect + tries to detect headers in the first row. If they are not detected, the + row is read as data. Otherwise data is read starting from the second row. + * skipLeadingRows is 0 - Instructs autodetect that there are no headers + and data should be read starting from the first row. * skipLeadingRows + = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row + N. If headers are not detected, row N is just skipped. Otherwise row N + is used to extract column names for the detected schema.' + format: int64 + type: string + type: object + HivePartitioningOptions: + properties: + mode: + description: '[Optional] When set, what mode of hive partitioning to use + when reading data. The following modes are supported. (1) AUTO: automatically + infer partition key name(s) and type(s). (2) STRINGS: automatically infer + partition key name(s). All types are interpreted as strings. (3) CUSTOM: + partition key schema is encoded in the source URI prefix. Not all storage + formats support hive partitioning. Requesting hive partitioning on an + unsupported format will lead to an error. Currently supported types include: + AVRO, CSV, JSON, ORC and Parquet.' + type: string + requirePartitionFilter: + description: '[Optional] If set to true, queries over this table require + a partition filter that can be used for partition elimination to be specified. + Note that this field should only be true when creating a permanent external + table or querying a temporary external table. Hive-partitioned loads with + requirePartitionFilter explicitly set to true will fail.' + type: boolean + sourceUriPrefix: + description: '[Optional] When hive partition detection is requested, a common + prefix for all source uris should be supplied. The prefix must end immediately + before the partition key encoding begins. For example, consider files + following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro + gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When + hive partitioning is requested with either AUTO or STRINGS detection, + the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ + (trailing slash does not matter).' + type: string + type: object + IterationResult: + properties: + durationMs: + description: Time taken to run the iteration in milliseconds. + format: int64 + type: string + evalLoss: + description: Loss computed on the eval data at the end of iteration. + format: double + type: number + index: + description: Index of the iteration, 0 based. + format: int32 + type: integer + learnRate: + description: Learn rate used for this iteration. + format: double + type: number + trainingLoss: + description: Loss computed on the training data at the end of iteration. + format: double + type: number + type: object + Job: + properties: + configuration: + $ref: '#/components/schemas/JobConfiguration' + description: '[Required] Describes the job configuration.' + etag: + description: '[Output-only] A hash of this resource.' + readOnly: true + type: string + id: + description: '[Output-only] Opaque ID field of the job' + readOnly: true + type: string + jobReference: + $ref: '#/components/schemas/JobReference' + description: '[Optional] Reference describing the unique-per-user name of + the job.' + kind: + default: bigquery#job + description: '[Output-only] The type of the resource.' + readOnly: true + type: string + selfLink: + description: '[Output-only] A URL that can be used to access this resource + again.' + readOnly: true + type: string + statistics: + $ref: '#/components/schemas/JobStatistics' + description: '[Output-only] Information about the job, including starting + time and ending time of the job.' + readOnly: true + status: + $ref: '#/components/schemas/JobStatus' + description: '[Output-only] The status of this job. Examine this value when + polling an asynchronous job to see if the job is complete.' + readOnly: true + user_email: + description: '[Output-only] Email address of the user who ran the job.' + readOnly: true + type: string + required: + - configuration + type: object + JobCancelResponse: + properties: + job: + $ref: '#/components/schemas/Job' + description: The final state of the job. + kind: + default: bigquery#jobCancelResponse + description: The resource type of the response. + type: string + type: object + JobConfiguration: + properties: + copy: + $ref: '#/components/schemas/JobConfigurationTableCopy' + description: '[Pick one] Copies a table.' + dryRun: + description: '[Optional] If set, don''t actually run this job. A valid query + will return a mostly empty response with some processing statistics, while + an invalid query will return the same error it would if it wasn''t a dry + run. Behavior of non-query jobs is undefined.' + type: boolean + extract: + $ref: '#/components/schemas/JobConfigurationExtract' + description: '[Pick one] Configures an extract job.' + jobTimeoutMs: + description: '[Optional] Job timeout in milliseconds. If this time limit + is exceeded, BigQuery may attempt to terminate the job.' + format: int64 + type: string + jobType: + description: '[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, + COPY or UNKNOWN.' + readOnly: true + type: string + labels: + additionalProperties: + type: string + description: The labels associated with this job. You can use these to organize + and group your jobs. Label keys and values can be no longer than 63 characters, + can only contain lowercase letters, numeric characters, underscores and + dashes. International characters are allowed. Label values are optional. + Label keys must start with a letter and each label in the list must have + a different key. + type: object + load: + $ref: '#/components/schemas/JobConfigurationLoad' + description: '[Pick one] Configures a load job.' + query: + $ref: '#/components/schemas/JobConfigurationQuery' + description: '[Pick one] Configures a query job.' + type: object + JobConfigurationExtract: + properties: + compression: + description: '[Optional] The compression type to use for exported files. + Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value + is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable + when extracting models.' + type: string + destinationFormat: + description: '[Optional] The exported file format. Possible values include + CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL + or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. + Tables with nested or repeated fields cannot be exported as CSV. The default + value for models is ML_TF_SAVED_MODEL.' + type: string + destinationUri: + description: '[Pick one] DEPRECATED: Use destinationUris instead, passing + only one URI as necessary. The fully-qualified Google Cloud Storage URI + where the extracted table should be written.' + type: string + destinationUris: + description: '[Pick one] A list of fully-qualified Google Cloud Storage + URIs where the extracted table should be written.' + items: + type: string + type: array + fieldDelimiter: + description: '[Optional] Delimiter to use between fields in the exported + data. Default is '',''. Not applicable when extracting models.' + type: string + printHeader: + default: true + description: '[Optional] Whether to print out a header row in the results. + Default is true. Not applicable when extracting models.' + type: boolean + sourceModel: + $ref: '#/components/schemas/ModelReference' + description: A reference to the model being exported. + sourceTable: + $ref: '#/components/schemas/TableReference' + description: A reference to the table being exported. + useAvroLogicalTypes: + description: '[Optional] If destinationFormat is set to "AVRO", this flag + indicates whether to enable extracting applicable column types (such as + TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), + instead of only using their raw types (avro-long). Not applicable when + extracting models.' + type: boolean + type: object + JobConfigurationLoad: + properties: + allowJaggedRows: + description: '[Optional] Accept rows that are missing trailing optional + columns. The missing values are treated as nulls. If false, records with + missing trailing columns are treated as bad records, and if there are + too many bad records, an invalid error is returned in the job result. + The default value is false. Only applicable to CSV, ignored for other + formats.' + type: boolean + allowQuotedNewlines: + description: Indicates if BigQuery should allow quoted data sections that + contain newline characters in a CSV file. The default value is false. + type: boolean + autodetect: + description: '[Optional] Indicates if we should automatically infer the + options and schema for CSV and JSON sources.' + type: boolean + clustering: + $ref: '#/components/schemas/Clustering' + description: '[Beta] Clustering specification for the destination table. + Must be specified with time-based partitioning, data in the table will + be first partitioned and subsequently clustered.' + createDisposition: + description: '[Optional] Specifies whether the job is allowed to create + new tables. The following values are supported: CREATE_IF_NEEDED: If the + table does not exist, BigQuery creates the table. CREATE_NEVER: The table + must already exist. If it does not, a ''notFound'' error is returned in + the job result. The default value is CREATE_IF_NEEDED. Creation, truncation + and append actions occur as one atomic update upon job completion.' + type: string + decimalTargetTypes: + description: '[Optional] Defines the list of possible SQL data types to + which the source decimal values are converted. This list and the precision + and the scale parameters of the decimal field determine the target type. + In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it + is in the specified list and if it supports the precision and the scale. + STRING supports all precision and scale values. If none of the listed + types supports the precision and the scale, the type supporting the widest + range in the specified list is picked, and if a value exceeds the supported + range when reading the data, an error will be thrown. Example: Suppose + the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) + is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer + digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); + (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported + range). This field cannot contain duplicate types. The order of the types + in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the + same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence + over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] + for the other file formats.' + items: + type: string + type: array + destinationEncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: Custom encryption configuration (e.g., Cloud KMS keys). + destinationTable: + $ref: '#/components/schemas/TableReference' + description: '[Required] The destination table to load the data into.' + destinationTableProperties: + $ref: '#/components/schemas/DestinationTableProperties' + description: '[Beta] [Optional] Properties with which to create the destination + table if it is new.' + encoding: + description: '[Optional] The character encoding of the data. The supported + values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes + the data after the raw, binary data has been split using the values of + the quote and fieldDelimiter properties.' + type: string + fieldDelimiter: + description: '[Optional] The separator for fields in a CSV file. The separator + can be any ISO-8859-1 single-byte character. To use a character in the + range 128-255, you must encode the character as UTF8. BigQuery converts + the string to ISO-8859-1 encoding, and then uses the first byte of the + encoded string to split the data in its raw, binary state. BigQuery also + supports the escape sequence "\t" to specify a tab separator. The default + value is a comma ('','').' + type: string + hivePartitioningOptions: + $ref: '#/components/schemas/HivePartitioningOptions' + description: '[Optional] Options to configure hive partitioning support.' + ignoreUnknownValues: + description: '[Optional] Indicates if BigQuery should allow extra values + that are not represented in the table schema. If true, the extra values + are ignored. If false, records with extra columns are treated as bad records, + and if there are too many bad records, an invalid error is returned in + the job result. The default value is false. The sourceFormat property + determines what BigQuery treats as an extra value: CSV: Trailing columns + JSON: Named values that don''t match any column names' + type: boolean + jsonExtension: + description: '[Optional] If sourceFormat is set to newline-delimited JSON, + indicates whether it should be processed as a JSON variant such as GeoJSON. + For a sourceFormat other than JSON, omit this field. If the sourceFormat + is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.' + type: string + maxBadRecords: + description: '[Optional] The maximum number of bad records that BigQuery + can ignore when running the job. If the number of bad records exceeds + this value, an invalid error is returned in the job result. This is only + valid for CSV and JSON. The default value is 0, which requires that all + records are valid.' + format: int32 + type: integer + nullMarker: + description: '[Optional] Specifies a string that represents a null value + in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" + as a null value when loading a CSV file. The default value is the empty + string. If you set this property to a custom value, BigQuery throws an + error if an empty string is present for all data types except for STRING + and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string + as an empty value.' + type: string + parquetOptions: + $ref: '#/components/schemas/ParquetOptions' + description: '[Optional] Options to configure parquet support.' + projectionFields: + description: If sourceFormat is set to "DATASTORE_BACKUP", indicates which + entity properties to load into BigQuery from a Cloud Datastore backup. + Property names are case sensitive and must be top-level properties. If + no properties are specified, BigQuery loads all properties. If any named + property isn't found in the Cloud Datastore backup, an invalid error is + returned in the job result. + items: + type: string + type: array + quote: + default: '"' + description: '[Optional] The value that is used to quote data sections in + a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then + uses the first byte of the encoded string to split the data in its raw, + binary state. The default value is a double-quote (''"''). If your data + does not contain quoted sections, set the property value to an empty string. + If your data contains quoted newline characters, you must also set the + allowQuotedNewlines property to true.' + pattern: .? + type: string + rangePartitioning: + $ref: '#/components/schemas/RangePartitioning' + description: '[TrustedTester] Range partitioning specification for this + table. Only one of timePartitioning and rangePartitioning should be specified.' + schema: + $ref: '#/components/schemas/TableSchema' + description: '[Optional] The schema for the destination table. The schema + can be omitted if the destination table already exists, or if you''re + loading data from Google Cloud Datastore.' + schemaInline: + description: '[Deprecated] The inline schema. For CSV schemas, specify as + "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, + baz:FLOAT".' + type: string + schemaInlineFormat: + description: '[Deprecated] The format of the schemaInline property.' + type: string + schemaUpdateOptions: + description: 'Allows the schema of the destination table to be updated as + a side effect of the load job if a schema is autodetected or supplied + in the job configuration. Schema update options are supported in two cases: + when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE + and the destination table is a partition of a table, specified by partition + decorators. For normal tables, WRITE_TRUNCATE will always overwrite the + schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: + allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow + relaxing a required field in the original schema to nullable.' + items: + type: string + type: array + skipLeadingRows: + description: '[Optional] The number of rows at the top of a CSV file that + BigQuery will skip when loading the data. The default value is 0. This + property is useful if you have header rows in the file that should be + skipped.' + format: int32 + type: integer + sourceFormat: + description: '[Optional] The format of the data files. For CSV files, specify + "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited + JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For + parquet, specify "PARQUET". For orc, specify "ORC". The default value + is CSV.' + type: string + sourceUris: + description: '[Required] The fully-qualified URIs that point to your data + in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one + ''*'' wildcard character and it must come after the ''bucket'' name. Size + limits related to load jobs apply to external data sources. For Google + Cloud Bigtable URIs: Exactly one URI can be specified and it has be a + fully specified and valid HTTPS URL for a Google Cloud Bigtable table. + For Google Cloud Datastore backups: Exactly one URI can be specified. + Also, the ''*'' wildcard character is not allowed.' + items: + type: string + type: array + timePartitioning: + $ref: '#/components/schemas/TimePartitioning' + description: Time-based partitioning specification for the destination table. + Only one of timePartitioning and rangePartitioning should be specified. + useAvroLogicalTypes: + description: '[Optional] If sourceFormat is set to "AVRO", indicates whether + to interpret logical types as the corresponding BigQuery data type (for + example, TIMESTAMP), instead of using the raw type (for example, INTEGER).' + type: boolean + writeDisposition: + description: '[Optional] Specifies the action that occurs if the destination + table already exists. The following values are supported: WRITE_TRUNCATE: + If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: + If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: + If the table already exists and contains data, a ''duplicate'' error is + returned in the job result. The default value is WRITE_APPEND. Each action + is atomic and only occurs if BigQuery is able to complete the job successfully. + Creation, truncation and append actions occur as one atomic update upon + job completion.' + type: string + required: + - destinationTable + - sourceUris + type: object + JobConfigurationQuery: + properties: + allowLargeResults: + default: false + description: '[Optional] If true and query uses legacy SQL dialect, allows + the query to produce arbitrarily large result tables at a slight cost + in performance. Requires destinationTable to be set. For standard SQL + queries, this flag is ignored and large results are always allowed. However, + you must still set destinationTable when result size exceeds the allowed + maximum response size.' + type: boolean + clustering: + $ref: '#/components/schemas/Clustering' + description: '[Beta] Clustering specification for the destination table. + Must be specified with time-based partitioning, data in the table will + be first partitioned and subsequently clustered.' + connectionProperties: + description: Connection properties. + items: + $ref: '#/components/schemas/ConnectionProperty' + type: array + createDisposition: + description: '[Optional] Specifies whether the job is allowed to create + new tables. The following values are supported: CREATE_IF_NEEDED: If the + table does not exist, BigQuery creates the table. CREATE_NEVER: The table + must already exist. If it does not, a ''notFound'' error is returned in + the job result. The default value is CREATE_IF_NEEDED. Creation, truncation + and append actions occur as one atomic update upon job completion.' + type: string + createSession: + description: If true, creates a new session, where session id will be a + server generated random id. If false, runs query with an existing session_id + passed in ConnectionProperty, otherwise runs query in non-session mode. + type: boolean + defaultDataset: + $ref: '#/components/schemas/DatasetReference' + description: '[Optional] Specifies the default dataset to use for unqualified + table names in the query. Note that this does not alter behavior of unqualified + dataset names.' + destinationEncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: Custom encryption configuration (e.g., Cloud KMS keys). + destinationTable: + $ref: '#/components/schemas/TableReference' + description: '[Optional] Describes the table where the query results should + be stored. If not present, a new table will be created to store the results. + This property must be set for large results that exceed the maximum response + size.' + flattenResults: + default: true + description: '[Optional] If true and query uses legacy SQL dialect, flattens + all nested and repeated fields in the query results. allowLargeResults + must be true if this is set to false. For standard SQL queries, this flag + is ignored and results are never flattened.' + type: boolean + maximumBillingTier: + default: 1 + description: '[Optional] Limits the billing tier for this job. Queries that + have resource usage beyond this tier will fail (without incurring a charge). + If unspecified, this will be set to your project default.' + format: int32 + type: integer + maximumBytesBilled: + description: '[Optional] Limits the bytes billed for this job. Queries that + will have bytes billed beyond this limit will fail (without incurring + a charge). If unspecified, this will be set to your project default.' + format: int64 + type: string + parameterMode: + description: Standard SQL only. Set to POSITIONAL to use positional (?) + query parameters or to NAMED to use named (@myparam) query parameters + in this query. + type: string + preserveNulls: + description: '[Deprecated] This property is deprecated.' + type: boolean + priority: + description: '[Optional] Specifies a priority for the query. Possible values + include INTERACTIVE and BATCH. The default value is INTERACTIVE.' + type: string + query: + description: '[Required] SQL query text to execute. The useLegacySql field + can be used to indicate whether the query uses legacy SQL or standard + SQL.' + type: string + queryParameters: + description: Query parameters for standard SQL queries. + items: + $ref: '#/components/schemas/QueryParameter' + type: array + rangePartitioning: + $ref: '#/components/schemas/RangePartitioning' + description: '[TrustedTester] Range partitioning specification for this + table. Only one of timePartitioning and rangePartitioning should be specified.' + schemaUpdateOptions: + description: 'Allows the schema of the destination table to be updated as + a side effect of the query job. Schema update options are supported in + two cases: when writeDisposition is WRITE_APPEND; when writeDisposition + is WRITE_TRUNCATE and the destination table is a partition of a table, + specified by partition decorators. For normal tables, WRITE_TRUNCATE will + always overwrite the schema. One or more of the following values are specified: + ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: + allow relaxing a required field in the original schema to nullable.' + items: + type: string + type: array + tableDefinitions: + additionalProperties: + $ref: '#/components/schemas/ExternalDataConfiguration' + description: '[Optional] If querying an external data source outside of + BigQuery, describes the data format, location and other properties of + the data source. By defining these properties, the data source can then + be queried as if it were a standard BigQuery table.' + type: object + timePartitioning: + $ref: '#/components/schemas/TimePartitioning' + description: Time-based partitioning specification for the destination table. + Only one of timePartitioning and rangePartitioning should be specified. + useLegacySql: + default: true + description: 'Specifies whether to use BigQuery''s legacy SQL dialect for + this query. The default value is true. If set to false, the query will + use BigQuery''s standard SQL: https://cloud.google.com/bigquery/sql-reference/ + When useLegacySql is set to false, the value of flattenResults is ignored; + query will be run as if flattenResults is false.' + type: boolean + useQueryCache: + default: true + description: '[Optional] Whether to look for the result in the query cache. + The query cache is a best-effort cache that will be flushed whenever tables + in the query are modified. Moreover, the query cache is only available + when a query does not have a destination table specified. The default + value is true.' + type: boolean + userDefinedFunctionResources: + description: Describes user-defined function resources used in the query. + items: + $ref: '#/components/schemas/UserDefinedFunctionResource' + type: array + writeDisposition: + description: '[Optional] Specifies the action that occurs if the destination + table already exists. The following values are supported: WRITE_TRUNCATE: + If the table already exists, BigQuery overwrites the table data and uses + the schema from the query result. WRITE_APPEND: If the table already exists, + BigQuery appends the data to the table. WRITE_EMPTY: If the table already + exists and contains data, a ''duplicate'' error is returned in the job + result. The default value is WRITE_EMPTY. Each action is atomic and only + occurs if BigQuery is able to complete the job successfully. Creation, + truncation and append actions occur as one atomic update upon job completion.' + type: string + required: + - query + type: object + JobConfigurationTableCopy: + properties: + createDisposition: + description: '[Optional] Specifies whether the job is allowed to create + new tables. The following values are supported: CREATE_IF_NEEDED: If the + table does not exist, BigQuery creates the table. CREATE_NEVER: The table + must already exist. If it does not, a ''notFound'' error is returned in + the job result. The default value is CREATE_IF_NEEDED. Creation, truncation + and append actions occur as one atomic update upon job completion.' + type: string + destinationEncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: Custom encryption configuration (e.g., Cloud KMS keys). + destinationExpirationTime: + description: '[Optional] The time when the destination table expires. Expired + tables will be deleted and their storage reclaimed.' + destinationTable: + $ref: '#/components/schemas/TableReference' + description: '[Required] The destination table' + operationType: + description: '[Optional] Supported operation types in table copy job.' + type: string + sourceTable: + $ref: '#/components/schemas/TableReference' + description: '[Pick one] Source table to copy.' + sourceTables: + description: '[Pick one] Source tables to copy.' + items: + $ref: '#/components/schemas/TableReference' + type: array + writeDisposition: + description: '[Optional] Specifies the action that occurs if the destination + table already exists. The following values are supported: WRITE_TRUNCATE: + If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: + If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: + If the table already exists and contains data, a ''duplicate'' error is + returned in the job result. The default value is WRITE_EMPTY. Each action + is atomic and only occurs if BigQuery is able to complete the job successfully. + Creation, truncation and append actions occur as one atomic update upon + job completion.' + type: string + required: + - destinationTable + type: object + JobList: + properties: + etag: + description: A hash of this page of results. + type: string + jobs: + description: List of jobs that were requested. + items: + properties: + configuration: + $ref: '#/components/schemas/JobConfiguration' + description: '[Full-projection-only] Specifies the job configuration.' + errorResult: + $ref: '#/components/schemas/ErrorProto' + description: A result object that will be present only if the job + has failed. + id: + description: Unique opaque ID of the job. + type: string + jobReference: + $ref: '#/components/schemas/JobReference' + description: Job reference uniquely identifying the job. + kind: + default: bigquery#job + description: The resource type. + type: string + state: + description: Running state of the job. When the state is DONE, errorResult + can be checked to determine whether the job succeeded or failed. + type: string + statistics: + $ref: '#/components/schemas/JobStatistics' + description: '[Output-only] Information about the job, including starting + time and ending time of the job.' + status: + $ref: '#/components/schemas/JobStatus' + description: '[Full-projection-only] Describes the state of the job.' + user_email: + description: '[Full-projection-only] Email address of the user who + ran the job.' + type: string + type: object + type: array + kind: + default: bigquery#jobList + description: The resource type of the response. + type: string + nextPageToken: + description: A token to request the next page of results. + type: string + type: object + JobReference: + properties: + jobId: + description: '[Required] The ID of the job. The ID must contain only letters + (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum + length is 1,024 characters.' + type: string + location: + description: The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + type: string + projectId: + description: '[Required] The ID of the project containing this job.' + type: string + required: + - jobId + - projectId + type: object + JobStatistics: + properties: + completionRatio: + description: '[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for + LOAD and EXTRACT jobs.' + format: double + type: number + creationTime: + description: '[Output-only] Creation time of this job, in milliseconds since + the epoch. This field will be present on all jobs.' + format: int64 + readOnly: true + type: string + endTime: + description: '[Output-only] End time of this job, in milliseconds since + the epoch. This field will be present whenever a job is in the DONE state.' + format: int64 + readOnly: true + type: string + extract: + $ref: '#/components/schemas/JobStatistics4' + description: '[Output-only] Statistics for an extract job.' + readOnly: true + load: + $ref: '#/components/schemas/JobStatistics3' + description: '[Output-only] Statistics for a load job.' + readOnly: true + numChildJobs: + description: '[Output-only] Number of child jobs executed.' + format: int64 + readOnly: true + type: string + parentJobId: + description: '[Output-only] If this is a child job, the id of the parent.' + readOnly: true + type: string + query: + $ref: '#/components/schemas/JobStatistics2' + description: '[Output-only] Statistics for a query job.' + readOnly: true + quotaDeferments: + description: '[Output-only] Quotas which delayed this job''s start time.' + items: + type: string + readOnly: true + type: array + reservationUsage: + description: '[Output-only] Job resource usage breakdown by reservation.' + items: + properties: + name: + description: '[Output-only] Reservation name or "unreserved" for on-demand + resources usage.' + type: string + slotMs: + description: '[Output-only] Slot-milliseconds the job spent in the + given reservation.' + format: int64 + type: string + type: object + readOnly: true + type: array + reservation_id: + description: '[Output-only] Name of the primary reservation assigned to + this job. Note that this could be different than reservations reported + in the reservation usage field if parent reservations were used to execute + this job.' + readOnly: true + type: string + rowLevelSecurityStatistics: + $ref: '#/components/schemas/RowLevelSecurityStatistics' + description: '[Output-only] [Preview] Statistics for row-level security. + Present only for query and extract jobs.' + readOnly: true + scriptStatistics: + $ref: '#/components/schemas/ScriptStatistics' + description: '[Output-only] Statistics for a child job of a script.' + readOnly: true + sessionInfo: + $ref: '#/components/schemas/SessionInfo' + description: '[Output-only] [Preview] Information of the session if this + job is part of one.' + readOnly: true + startTime: + description: '[Output-only] Start time of this job, in milliseconds since + the epoch. This field will be present when the job transitions from the + PENDING state to either RUNNING or DONE.' + format: int64 + readOnly: true + type: string + totalBytesProcessed: + description: '[Output-only] [Deprecated] Use the bytes processed in the + query statistics instead.' + format: int64 + readOnly: true + type: string + totalSlotMs: + description: '[Output-only] Slot-milliseconds for the job.' + format: int64 + readOnly: true + type: string + transactionInfo: + $ref: '#/components/schemas/TransactionInfo' + description: '[Output-only] [Alpha] Information of the multi-statement transaction + if this job is part of one.' + readOnly: true + type: object + JobStatistics2: + properties: + biEngineStatistics: + $ref: '#/components/schemas/BiEngineStatistics' + description: BI Engine specific Statistics. [Output-only] BI Engine specific + Statistics. + billingTier: + description: '[Output-only] Billing tier for the job.' + format: int32 + readOnly: true + type: integer + cacheHit: + description: '[Output-only] Whether the query result was fetched from the + query cache.' + readOnly: true + type: boolean + ddlAffectedRowAccessPolicyCount: + description: '[Output-only] [Preview] The number of row access policies + affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES + queries.' + format: int64 + readOnly: true + type: string + ddlDestinationTable: + $ref: '#/components/schemas/TableReference' + description: '[Output-only] The DDL destination table. Present only for + ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just + for its type information.' + readOnly: true + ddlOperationPerformed: + description: 'The DDL operation performed, possibly dependent on the pre-existence + of the DDL target. Possible values (new values might be added in the future): + "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: + the query is CREATE TABLE IF NOT EXISTS while the table already exists, + or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": + The query replaced the DDL target. Example case: the query is CREATE OR + REPLACE TABLE, and the table already exists. "DROP": The query deleted + the DDL target.' + type: string + ddlTargetDataset: + $ref: '#/components/schemas/DatasetReference' + description: '[Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP + SCHEMA queries.' + readOnly: true + ddlTargetRoutine: + $ref: '#/components/schemas/RoutineReference' + description: The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE + queries. + ddlTargetRowAccessPolicy: + $ref: '#/components/schemas/RowAccessPolicyReference' + description: '[Output-only] [Preview] The DDL target row access policy. + Present only for CREATE/DROP ROW ACCESS POLICY queries.' + readOnly: true + ddlTargetTable: + $ref: '#/components/schemas/TableReference' + description: '[Output-only] The DDL target table. Present only for CREATE/DROP + TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.' + readOnly: true + dmlStats: + $ref: '#/components/schemas/DmlStatistics' + description: '[Output-only] Detailed statistics for DML statements Present + only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.' + readOnly: true + estimatedBytesProcessed: + description: '[Output-only] The original estimate of bytes processed for + the job.' + format: int64 + readOnly: true + type: string + mlStatistics: + $ref: '#/components/schemas/MlStatistics' + description: '[Output-only] Statistics of a BigQuery ML training job.' + readOnly: true + modelTraining: + $ref: '#/components/schemas/BigQueryModelTraining' + description: '[Output-only, Beta] Information about create model query job + progress.' + modelTrainingCurrentIteration: + description: '[Output-only, Beta] Deprecated; do not use.' + format: int32 + type: integer + modelTrainingExpectedTotalIteration: + description: '[Output-only, Beta] Deprecated; do not use.' + format: int64 + type: string + numDmlAffectedRows: + description: '[Output-only] The number of rows affected by a DML statement. + Present only for DML statements INSERT, UPDATE or DELETE.' + format: int64 + readOnly: true + type: string + queryPlan: + description: '[Output-only] Describes execution plan for the query.' + items: + $ref: '#/components/schemas/ExplainQueryStage' + readOnly: true + type: array + referencedRoutines: + description: '[Output-only] Referenced routines (persistent user-defined + functions and stored procedures) for the job.' + items: + $ref: '#/components/schemas/RoutineReference' + readOnly: true + type: array + referencedTables: + description: '[Output-only] Referenced tables for the job. Queries that + reference more than 50 tables will not have a complete list.' + items: + $ref: '#/components/schemas/TableReference' + readOnly: true + type: array + reservationUsage: + description: '[Output-only] Job resource usage breakdown by reservation.' + items: + properties: + name: + description: '[Output-only] Reservation name or "unreserved" for on-demand + resources usage.' + type: string + slotMs: + description: '[Output-only] Slot-milliseconds the job spent in the + given reservation.' + format: int64 + type: string + type: object + readOnly: true + type: array + schema: + $ref: '#/components/schemas/TableSchema' + description: '[Output-only] The schema of the results. Present only for + successful dry run of non-legacy SQL queries.' + readOnly: true + statementType: + description: 'The type of query statement, if valid. Possible values (new + values might be added in the future): "SELECT": SELECT query. "INSERT": + INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. + "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. + "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. + "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. + "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": + ASSERT condition AS ''description''. "CREATE_FUNCTION": CREATE FUNCTION + query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": + CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without + AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS + SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... + . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE + query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.' + type: string + timeline: + description: '[Output-only] [Beta] Describes a timeline of job execution.' + items: + $ref: '#/components/schemas/QueryTimelineSample' + readOnly: true + type: array + totalBytesBilled: + description: '[Output-only] Total bytes billed for the job.' + format: int64 + readOnly: true + type: string + totalBytesProcessed: + description: '[Output-only] Total bytes processed for the job.' + format: int64 + readOnly: true + type: string + totalBytesProcessedAccuracy: + description: '[Output-only] For dry-run jobs, totalBytesProcessed is an + estimate and this field specifies the accuracy of the estimate. Possible + values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: + estimate is precise. LOWER_BOUND: estimate is lower bound of what the + query would cost. UPPER_BOUND: estimate is upper bound of what the query + would cost.' + readOnly: true + type: string + totalPartitionsProcessed: + description: '[Output-only] Total number of partitions processed from all + partitioned tables referenced in the job.' + format: int64 + readOnly: true + type: string + totalSlotMs: + description: '[Output-only] Slot-milliseconds for the job.' + format: int64 + readOnly: true + type: string + undeclaredQueryParameters: + description: 'Standard SQL only: list of undeclared query parameters detected + during a dry run validation.' + items: + $ref: '#/components/schemas/QueryParameter' + type: array + type: object + JobStatistics3: + properties: + badRecords: + description: '[Output-only] The number of bad records encountered. Note + that if the job has failed because of more bad records encountered than + the maximum allowed in the load job configuration, then this number can + be less than the total number of bad records present in the input data.' + format: int64 + readOnly: true + type: string + inputFileBytes: + description: '[Output-only] Number of bytes of source data in a load job.' + format: int64 + readOnly: true + type: string + inputFiles: + description: '[Output-only] Number of source files in a load job.' + format: int64 + readOnly: true + type: string + outputBytes: + description: '[Output-only] Size of the loaded data in bytes. Note that + while a load job is in the running state, this value may change.' + format: int64 + readOnly: true + type: string + outputRows: + description: '[Output-only] Number of rows imported in a load job. Note + that while an import job is in the running state, this value may change.' + format: int64 + readOnly: true + type: string + type: object + JobStatistics4: + properties: + destinationUriFileCounts: + description: '[Output-only] Number of files per destination URI or URI pattern + specified in the extract configuration. These values will be in the same + order as the URIs specified in the ''destinationUris'' field.' + items: + format: int64 + type: string + readOnly: true + type: array + inputBytes: + description: '[Output-only] Number of user bytes extracted into the result. + This is the byte count as computed by BigQuery for billing purposes.' + format: int64 + readOnly: true + type: string + type: object + JobStatus: + properties: + errorResult: + $ref: '#/components/schemas/ErrorProto' + description: '[Output-only] Final error result of the job. If present, indicates + that the job has completed and was unsuccessful.' + readOnly: true + errors: + description: '[Output-only] The first errors encountered during the running + of the job. The final message includes the number of errors that caused + the process to stop. Errors here do not necessarily mean that the job + has completed or was unsuccessful.' + items: + $ref: '#/components/schemas/ErrorProto' + readOnly: true + type: array + state: + description: '[Output-only] Running state of the job.' + readOnly: true + type: string + type: object + JsonObject: + additionalProperties: + $ref: '#/components/schemas/JsonValue' + description: Represents a single JSON object. + type: object + JsonValue: {} + ListModelsResponse: + properties: + models: + description: 'Models in the requested dataset. Only the following fields + are populated: model_reference, model_type, creation_time, last_modified_time + and labels.' + items: + $ref: '#/components/schemas/Model' + type: array + nextPageToken: + description: A token to request the next page of results. + type: string + type: object + ListRoutinesResponse: + properties: + nextPageToken: + description: A token to request the next page of results. + type: string + routines: + description: 'Routines in the requested dataset. Unless read_mask is set + in the request, only the following fields are populated: etag, project_id, + dataset_id, routine_id, routine_type, creation_time, last_modified_time, + and language.' + items: + $ref: '#/components/schemas/Routine' + type: array + type: object + ListRowAccessPoliciesResponse: + description: Response message for the ListRowAccessPolicies method. + properties: + nextPageToken: + description: A token to request the next page of results. + type: string + rowAccessPolicies: + description: Row access policies on the requested table. + items: + $ref: '#/components/schemas/RowAccessPolicy' + type: array + type: object + LocationMetadata: + description: BigQuery-specific metadata about a location. This will be set on + google.cloud.location.Location.metadata in Cloud Location API responses. + properties: + legacyLocationId: + description: "The legacy BigQuery location ID, e.g. \u201CEU\u201D for the\ + \ \u201Ceurope\u201D location. This is for any API consumers that need\ + \ the legacy \u201CUS\u201D and \u201CEU\u201D locations." + type: string + type: object + MaterializedViewDefinition: + properties: + enableRefresh: + description: '[Optional] [TrustedTester] Enable automatic refresh of the + materialized view when the base table is updated. The default value is + "true".' + type: boolean + lastRefreshTime: + description: '[Output-only] [TrustedTester] The time when this materialized + view was last modified, in milliseconds since the epoch.' + format: int64 + readOnly: true + type: string + query: + description: '[Required] A query whose result is persisted.' + type: string + refreshIntervalMs: + description: '[Optional] [TrustedTester] The maximum frequency at which + this materialized view will be refreshed. The default value is "1800000" + (30 minutes).' + format: int64 + type: string + required: + - query + type: object + MlStatistics: + properties: + iterationResults: + description: Results for all completed iterations. + items: + $ref: '#/components/schemas/IterationResult' + type: array + maxIterations: + description: Maximum number of iterations specified as max_iterations in + the 'CREATE MODEL' query. The actual number of iterations may be less + than this number due to early stop. + format: int64 + type: string + type: object + Model: + properties: + bestTrialId: + description: The best trial_id across all training runs. + format: int64 + type: string + creationTime: + description: Output only. The time when this model was created, in millisecs + since the epoch. + format: int64 + readOnly: true + type: string + description: + description: Optional. A user-friendly description of this model. + type: string + encryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: Custom encryption configuration (e.g., Cloud KMS keys). This + shows the encryption configuration of the model data while stored in BigQuery + storage. This field can be used with PatchModel to update encryption key + for an already encrypted model. + etag: + description: Output only. A hash of this resource. + readOnly: true + type: string + expirationTime: + description: Optional. The time when this model expires, in milliseconds + since the epoch. If not present, the model will persist indefinitely. + Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs + property of the encapsulating dataset can be used to set a default expirationTime + on newly created models. + format: int64 + type: string + featureColumns: + description: Output only. Input feature columns that were used to train + this model. + items: + $ref: '#/components/schemas/StandardSqlField' + readOnly: true + type: array + friendlyName: + description: Optional. A descriptive name for this model. + type: string + labelColumns: + description: Output only. Label columns that were used to train this model. + The output of the model will have a "predicted_" prefix to these columns. + items: + $ref: '#/components/schemas/StandardSqlField' + readOnly: true + type: array + labels: + additionalProperties: + type: string + description: The labels associated with this model. You can use these to + organize and group your models. Label keys and values can be no longer + than 63 characters, can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. Label values + are optional. Label keys must start with a letter and each label in the + list must have a different key. + type: object + lastModifiedTime: + description: Output only. The time when this model was last modified, in + millisecs since the epoch. + format: int64 + readOnly: true + type: string + location: + description: Output only. The geographic location where the model resides. + This value is inherited from the dataset. + readOnly: true + type: string + modelReference: + $ref: '#/components/schemas/ModelReference' + description: Required. Unique identifier for this model. + modelType: + description: Output only. Type of the model resource. + enum: + - MODEL_TYPE_UNSPECIFIED + - LINEAR_REGRESSION + - LOGISTIC_REGRESSION + - KMEANS + - MATRIX_FACTORIZATION + - DNN_CLASSIFIER + - TENSORFLOW + - DNN_REGRESSOR + - BOOSTED_TREE_REGRESSOR + - BOOSTED_TREE_CLASSIFIER + - ARIMA + - AUTOML_REGRESSOR + - AUTOML_CLASSIFIER + - ARIMA_PLUS + readOnly: true + type: string + trainingRuns: + description: Output only. Information for all training runs in increasing + order of start_time. + items: + $ref: '#/components/schemas/TrainingRun' + readOnly: true + type: array + type: object + ModelDefinition: + properties: + modelOptions: + description: '[Output-only, Beta] Model options used for the first training + run. These options are immutable for subsequent training runs. Default + values are used for any options not specified in the input query.' + properties: + labels: + items: + type: string + type: array + lossType: + type: string + modelType: + type: string + type: object + trainingRuns: + description: '[Output-only, Beta] Information about ml training runs, each + training run comprises of multiple iterations and there may be multiple + training runs for the model if warm start is used or if a user decides + to continue a previously cancelled query.' + items: + $ref: '#/components/schemas/BqmlTrainingRun' + type: array + type: object + ModelReference: + properties: + datasetId: + description: '[Required] The ID of the dataset containing this model.' + type: string + modelId: + description: '[Required] The ID of the model. The ID must contain only letters + (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 + characters.' + type: string + projectId: + description: '[Required] The ID of the project containing this model.' + type: string + required: + - datasetId + - modelId + - projectId + type: object + MultiClassClassificationMetrics: + description: Evaluation metrics for multi-class classification/classifier models. + properties: + aggregateClassificationMetrics: + $ref: '#/components/schemas/AggregateClassificationMetrics' + description: Aggregate classification metrics. + confusionMatrixList: + description: Confusion matrix at different thresholds. + items: + $ref: '#/components/schemas/ConfusionMatrix' + type: array + type: object + ParquetOptions: + properties: + enableListInference: + description: '[Optional] Indicates whether to use schema inference specifically + for Parquet LIST logical type.' + type: boolean + enumAsString: + description: '[Optional] Indicates whether to infer Parquet ENUM logical + type as STRING instead of BYTES by default.' + type: boolean + 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/).' + properties: + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + items: + $ref: '#/components/schemas/AuditConfig' + type: array + bindings: + description: Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when the + `bindings` are applied. Each of the `bindings` must contain at least one + principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; + up to 250 of these principals can be Google groups. Each occurrence of + a principal counts towards these limits. For example, if the `bindings` + grant 50 different roles to `user:alice@example.com`, and not to any other + principal, then you can add another 1,450 principals to the `bindings` + in the `Policy`. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: '`etag` is used for optimistic concurrency control as a way + to help prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` in + the read-modify-write cycle to perform policy updates in order to avoid + race conditions: An `etag` is returned in the response to `getIamPolicy`, + and systems are expected to put that etag in the request to `setIamPolicy` + to ensure that their change will be applied to the same version of the + policy. **Important:** If you use IAM Conditions, you must include the + `etag` field whenever you call `setIamPolicy`. If you omit this field, + then IAM allows you to overwrite a version `3` policy with a version `1` + policy, and all of the conditions in the version `3` policy are lost.' + format: byte + type: string + version: + description: 'Specifies the format of the policy. Valid values are `0`, + `1`, and `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify version + `3`. This requirement applies to the following operations: * Getting a + policy that includes a conditional role binding * Adding a conditional + role binding to a policy * Changing a conditional role binding in a policy + * Removing any role binding, with or without a condition, from a policy + that includes conditions **Important:** If you use IAM Conditions, you + must include the `etag` field whenever you call `setIamPolicy`. If you + omit this field, then IAM allows you to overwrite a version `3` policy + with a version `1` policy, and all of the conditions in the version `3` + policy are lost. If a policy does not include any conditions, operations + on that policy may specify any valid version or leave the field unset. + To learn which resources support conditions in their IAM policies, see + the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).' + format: int32 + type: integer + type: object + ProjectList: + properties: + etag: + description: A hash of the page of results + type: string + kind: + default: bigquery#projectList + description: The type of list. + type: string + nextPageToken: + description: A token to request the next page of results. + type: string + projects: + description: Projects to which you have at least READ access. + items: + properties: + friendlyName: + description: A descriptive name for this project. + type: string + id: + description: An opaque ID of this project. + type: string + kind: + default: bigquery#project + description: The resource type. + type: string + numericId: + description: The numeric ID of this project. + format: uint64 + type: string + projectReference: + $ref: '#/components/schemas/ProjectReference' + description: A unique reference to this project. + type: object + type: array + totalItems: + description: The total number of projects in the list. + format: int32 + type: integer + type: object + ProjectReference: + properties: + projectId: + description: '[Required] ID of the project. Can be either the numeric ID + or the assigned ID of the project.' + type: string + required: + - projectId + type: object + QueryParameter: + properties: + name: + description: '[Optional] If unset, this is a positional parameter. Otherwise, + should be unique within a query.' + type: string + parameterType: + $ref: '#/components/schemas/QueryParameterType' + description: '[Required] The type of this parameter.' + parameterValue: + $ref: '#/components/schemas/QueryParameterValue' + description: '[Required] The value of this parameter.' + required: + - parameterType + - parameterValue + type: object + QueryParameterType: + properties: + arrayType: + $ref: '#/components/schemas/QueryParameterType' + description: '[Optional] The type of the array''s elements, if this is an + array.' + structTypes: + description: '[Optional] The types of the fields of this struct, in order, + if this is a struct.' + items: + properties: + description: + description: '[Optional] Human-oriented description of the field.' + type: string + name: + description: '[Optional] The name of this field.' + type: string + type: + $ref: '#/components/schemas/QueryParameterType' + description: '[Required] The type of this field.' + type: object + type: array + type: + description: '[Required] The top level type of this field.' + type: string + required: + - type + type: object + QueryParameterValue: + properties: + arrayValues: + description: '[Optional] The array values, if this is an array type.' + items: + $ref: '#/components/schemas/QueryParameterValue' + type: array + structValues: + additionalProperties: + $ref: '#/components/schemas/QueryParameterValue' + description: '[Optional] The struct field values, in order of the struct + type''s declaration.' + type: object + value: + description: '[Optional] The value of this value, if a simple scalar type.' + type: string + type: object + QueryRequest: + properties: + connectionProperties: + description: Connection properties. + items: + $ref: '#/components/schemas/ConnectionProperty' + type: array + createSession: + description: If true, creates a new session, where session id will be a + server generated random id. If false, runs query with an existing session_id + passed in ConnectionProperty, otherwise runs query in non-session mode. + type: boolean + defaultDataset: + $ref: '#/components/schemas/DatasetReference' + description: '[Optional] Specifies the default datasetId and projectId to + assume for any unqualified table names in the query. If not set, all table + names in the query string must be qualified in the format ''datasetId.tableId''.' + dryRun: + description: '[Optional] If set to true, BigQuery doesn''t run the job. + Instead, if the query is valid, BigQuery returns statistics about the + job such as how many bytes would be processed. If the query is invalid, + an error returns. The default value is false.' + type: boolean + kind: + default: bigquery#queryRequest + description: The resource type of the request. + type: string + labels: + additionalProperties: + type: string + description: The labels associated with this job. You can use these to organize + and group your jobs. Label keys and values can be no longer than 63 characters, + can only contain lowercase letters, numeric characters, underscores and + dashes. International characters are allowed. Label values are optional. + Label keys must start with a letter and each label in the list must have + a different key. + type: object + location: + description: The geographic location where the job should run. See details + at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + type: string + maxResults: + description: '[Optional] The maximum number of rows of data to return per + page of results. Setting this flag to a small value such as 1000 and then + paging through results might improve reliability when the query result + set is large. In addition to this limit, responses are also limited to + 10 MB. By default, there is no maximum row count, and only the byte limit + applies.' + format: uint32 + type: integer + maximumBytesBilled: + description: '[Optional] Limits the bytes billed for this job. Queries that + will have bytes billed beyond this limit will fail (without incurring + a charge). If unspecified, this will be set to your project default.' + format: int64 + type: string + parameterMode: + description: Standard SQL only. Set to POSITIONAL to use positional (?) + query parameters or to NAMED to use named (@myparam) query parameters + in this query. + type: string + preserveNulls: + description: '[Deprecated] This property is deprecated.' + type: boolean + query: + description: '[Required] A query string, following the BigQuery query syntax, + of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".' + type: string + queryParameters: + description: Query parameters for Standard SQL queries. + items: + $ref: '#/components/schemas/QueryParameter' + type: array + requestId: + description: 'A unique user provided identifier to ensure idempotent behavior + for queries. Note that this is different from the job_id. It has the following + properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. + A UUID is recommended. 2. Read only queries can ignore this token since + they are nullipotent by definition. 3. For the purposes of idempotency + ensured by the request_id, a request is considered duplicate of another + only if they have the same request_id and are actually duplicates. When + determining whether a request is a duplicate of the previous request, + all parameters in the request that may affect the behavior are considered. + For example, query, connection_properties, query_parameters, use_legacy_sql + are parameters that affect the result and are considered when determining + whether a request is a duplicate, but properties like timeout_ms don''t + affect the result and are thus not considered. Dry run query requests + are never considered duplicate of another request. 4. When a duplicate + mutating query request is detected, it returns: a. the results of the + mutation if it completes successfully within the timeout. b. the running + operation if it is still in progress at the end of the timeout. 5. Its + lifetime is limited to 15 minutes. In other words, if two requests are + sent with the same request_id, but more than 15 minutes apart, idempotency + is not guaranteed.' + type: string + timeoutMs: + description: '[Optional] How long to wait for the query to complete, in + milliseconds, before the request times out and returns. Note that this + is only a timeout for the request, not the query. If the query takes longer + to run than the timeout value, the call returns without any results and + with the ''jobComplete'' flag set to false. You can call GetQueryResults() + to wait for the query to complete and read the results. The default value + is 10000 milliseconds (10 seconds).' + format: uint32 + type: integer + useLegacySql: + default: true + description: 'Specifies whether to use BigQuery''s legacy SQL dialect for + this query. The default value is true. If set to false, the query will + use BigQuery''s standard SQL: https://cloud.google.com/bigquery/sql-reference/ + When useLegacySql is set to false, the value of flattenResults is ignored; + query will be run as if flattenResults is false.' + type: boolean + useQueryCache: + default: true + description: '[Optional] Whether to look for the result in the query cache. + The query cache is a best-effort cache that will be flushed whenever tables + in the query are modified. The default value is true.' + type: boolean + required: + - query + type: object + QueryResponse: + properties: + cacheHit: + description: Whether the query result was fetched from the query cache. + type: boolean + dmlStats: + $ref: '#/components/schemas/DmlStatistics' + description: '[Output-only] Detailed statistics for DML statements Present + only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.' + readOnly: true + errors: + description: '[Output-only] The first errors or warnings encountered during + the running of the job. The final message includes the number of errors + that caused the process to stop. Errors here do not necessarily mean that + the job has completed or was unsuccessful.' + items: + $ref: '#/components/schemas/ErrorProto' + readOnly: true + type: array + jobComplete: + description: Whether the query has completed or not. If rows or totalRows + are present, this will always be true. If this is false, totalRows will + not be available. + type: boolean + jobReference: + $ref: '#/components/schemas/JobReference' + description: Reference to the Job that was created to run the query. This + field will be present even if the original request timed out, in which + case GetQueryResults can be used to read the results once the query has + completed. Since this API only returns the first page of results, subsequent + pages can be fetched via the same mechanism (GetQueryResults). + kind: + default: bigquery#queryResponse + description: The resource type. + type: string + numDmlAffectedRows: + description: '[Output-only] The number of rows affected by a DML statement. + Present only for DML statements INSERT, UPDATE or DELETE.' + format: int64 + readOnly: true + type: string + pageToken: + description: A token used for paging results. + type: string + rows: + description: An object with as many results as can be contained within the + maximum permitted reply size. To get any additional rows, you can call + GetQueryResults and specify the jobReference returned above. + items: + $ref: '#/components/schemas/TableRow' + type: array + schema: + $ref: '#/components/schemas/TableSchema' + description: The schema of the results. Present only when the query completes + successfully. + sessionInfo: + $ref: '#/components/schemas/SessionInfo' + description: '[Output-only] [Preview] Information of the session if this + job is part of one.' + readOnly: true + totalBytesProcessed: + description: The total number of bytes processed for this query. If this + query was a dry run, this is the number of bytes that would be processed + if the query were run. + format: int64 + type: string + totalRows: + description: The total number of rows in the complete query result set, + which can be more than the number of rows in this single page of results. + format: uint64 + type: string + type: object + QueryTimelineSample: + properties: + activeUnits: + description: Total number of units currently being processed by workers. + This does not correspond directly to slot usage. This is the largest value + observed since the last sample. + format: int64 + type: string + completedUnits: + description: Total parallel units of work completed by this query. + format: int64 + type: string + elapsedMs: + description: Milliseconds elapsed since the start of query execution. + format: int64 + type: string + pendingUnits: + description: Total parallel units of work remaining for the active stages. + format: int64 + type: string + totalSlotMs: + description: Cumulative slot-ms consumed by the query. + format: int64 + type: string + type: object + RangePartitioning: + properties: + field: + description: '[TrustedTester] [Required] The table is partitioned by this + field. The field must be a top-level NULLABLE/REQUIRED field. The only + supported type is INTEGER/INT64.' + type: string + range: + description: '[TrustedTester] [Required] Defines the ranges for range partitioning.' + properties: + end: + description: '[TrustedTester] [Required] The end of range partitioning, + exclusive.' + format: int64 + type: string + interval: + description: '[TrustedTester] [Required] The width of each interval.' + format: int64 + type: string + start: + description: '[TrustedTester] [Required] The start of range partitioning, + inclusive.' + format: int64 + type: string + type: object + type: object + RankingMetrics: + description: Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. + properties: + averageRank: + description: Determines the goodness of a ranking by computing the percentile + rank from the predicted confidence and dividing it by the original rank. + format: double + type: number + meanAveragePrecision: + description: Calculates a precision per user for all the items by ranking + them and then averages all the precisions across all the users. + format: double + type: number + meanSquaredError: + description: Similar to the mean squared error computed in regression and + explicit recommendation models except instead of computing the rating + directly, the output from evaluate is computed against a preference which + is 1 or 0 depending on if the rating exists or not. + format: double + type: number + normalizedDiscountedCumulativeGain: + description: A metric to determine the goodness of a ranking calculated + from the predicted confidence by comparing it to an ideal rank measured + by the original ratings. + format: double + type: number + type: object + RegressionMetrics: + description: Evaluation metrics for regression and explicit feedback type matrix + factorization models. + properties: + meanAbsoluteError: + description: Mean absolute error. + format: double + type: number + meanSquaredError: + description: Mean squared error. + format: double + type: number + meanSquaredLogError: + description: Mean squared log error. + format: double + type: number + medianAbsoluteError: + description: Median absolute error. + format: double + type: number + rSquared: + description: R^2 score. This corresponds to r2_score in ML.EVALUATE. + format: double + type: number + type: object + Routine: + description: A user-defined function or a stored procedure. + properties: + arguments: + description: Optional. + items: + $ref: '#/components/schemas/Argument' + type: array + creationTime: + description: Output only. The time when this routine was created, in milliseconds + since the epoch. + format: int64 + readOnly: true + type: string + definitionBody: + description: 'Required. The body of the routine. For functions, this is + the expression in the AS clause. If language=SQL, it is the substring + inside (but excluding) the parentheses. For example, for the function + created with the following statement: `CREATE FUNCTION JoinLines(x string, + y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", + y)` (\n is not replaced with linebreak). If language=JAVASCRIPT, it is + the evaluated string in the AS clause. For example, for the function created + with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE + js AS ''return "\n";\n''` The definition_body is `return "\n";\n` Note + that both \n are replaced with linebreaks.' + type: string + description: + description: Optional. The description of the routine, if defined. + type: string + determinismLevel: + description: Optional. The determinism level of the JavaScript UDF, if defined. + enum: + - DETERMINISM_LEVEL_UNSPECIFIED + - DETERMINISTIC + - NOT_DETERMINISTIC + type: string + etag: + description: Output only. A hash of this resource. + readOnly: true + type: string + importedLibraries: + description: Optional. If language = "JAVASCRIPT", this field stores the + path of the imported JAVASCRIPT libraries. + items: + type: string + type: array + language: + description: Optional. Defaults to "SQL". + enum: + - LANGUAGE_UNSPECIFIED + - SQL + - JAVASCRIPT + type: string + lastModifiedTime: + description: Output only. The time when this routine was last modified, + in milliseconds since the epoch. + format: int64 + readOnly: true + type: string + returnTableType: + $ref: '#/components/schemas/StandardSqlTableType' + description: Optional. Can be set only if routine_type = "TABLE_VALUED_FUNCTION". + If absent, the return table type is inferred from definition_body at query + time in each query that references this routine. If present, then the + columns in the evaluated table result will be cast to match the column + types specificed in return table type, at query time. + returnType: + $ref: '#/components/schemas/StandardSqlDataType' + description: 'Optional if language = "SQL"; required otherwise. Cannot be + set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type + is inferred from definition_body at query time in each query that references + this routine. If present, then the evaluated result will be cast to the + specified returned type at query time. For example, for the functions + created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, + y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x + FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS + FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` + for `Add` and `Decrement`, and is absent for `Increment` (inferred as + FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE + OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred + return type of `Increment` is automatically changed to INT64 at query + time, while the return type of `Decrement` remains FLOAT64.' + routineReference: + $ref: '#/components/schemas/RoutineReference' + description: Required. Reference describing the ID of this routine. + routineType: + description: Required. The type of routine. + enum: + - ROUTINE_TYPE_UNSPECIFIED + - SCALAR_FUNCTION + - PROCEDURE + - TABLE_VALUED_FUNCTION + type: string + strictMode: + description: Optional. Can be set for procedures only. If true (default), + the definition body will be validated in the creation and the updates + of the procedure. For procedures with an argument of ANY TYPE, the definition + body validtion is not supported at creation/update time, and thus this + field must be set to false explicitly. + type: boolean + type: object + RoutineReference: + properties: + datasetId: + description: '[Required] The ID of the dataset containing this routine.' + type: string + projectId: + description: '[Required] The ID of the project containing this routine.' + type: string + routineId: + description: '[Required] The ID of the routine. The ID must contain only + letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length + is 256 characters.' + type: string + required: + - datasetId + - projectId + - routineId + type: object + Row: + description: A single row in the confusion matrix. + properties: + actualLabel: + description: The original label of this row. + type: string + entries: + description: Info describing predicted label distribution. + items: + $ref: '#/components/schemas/Entry' + type: array + type: object + RowAccessPolicy: + description: Represents access on a subset of rows on the specified table, defined + by its filter predicate. Access to the subset of rows is controlled by its + IAM policy. + properties: + creationTime: + description: Output only. The time when this row access policy was created, + in milliseconds since the epoch. + format: google-datetime + readOnly: true + type: string + etag: + description: Output only. A hash of this resource. + readOnly: true + type: string + filterPredicate: + description: 'Required. A SQL boolean expression that represents the rows + defined by this row access policy, similar to the boolean expression in + a WHERE clause of a SELECT query on a table. References to other tables, + routines, and temporary functions are not supported. Examples: region="EU" + date_field = CAST(''2019-9-27'' as DATE) nullable_field is not NULL numeric_field + BETWEEN 1.0 AND 5.0' + type: string + lastModifiedTime: + description: Output only. The time when this row access policy was last + modified, in milliseconds since the epoch. + format: google-datetime + readOnly: true + type: string + rowAccessPolicyReference: + $ref: '#/components/schemas/RowAccessPolicyReference' + description: Required. Reference describing the ID of this row access policy. + type: object + RowAccessPolicyReference: + properties: + datasetId: + description: '[Required] The ID of the dataset containing this row access + policy.' + type: string + policyId: + description: '[Required] The ID of the row access policy. The ID must contain + only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum + length is 256 characters.' + type: string + projectId: + description: '[Required] The ID of the project containing this row access + policy.' + type: string + tableId: + description: '[Required] The ID of the table containing this row access + policy.' + type: string + required: + - datasetId + - policyId + - projectId + - tableId + type: object + RowLevelSecurityStatistics: + properties: + rowLevelSecurityApplied: + description: '[Output-only] [Preview] Whether any accessed data was protected + by row access policies.' + readOnly: true + type: boolean + type: object + ScriptStackFrame: + properties: + endColumn: + description: '[Output-only] One-based end column.' + format: int32 + readOnly: true + type: integer + endLine: + description: '[Output-only] One-based end line.' + format: int32 + readOnly: true + type: integer + procedureId: + description: '[Output-only] Name of the active procedure, empty if in a + top-level script.' + readOnly: true + type: string + startColumn: + description: '[Output-only] One-based start column.' + format: int32 + readOnly: true + type: integer + startLine: + description: '[Output-only] One-based start line.' + format: int32 + readOnly: true + type: integer + text: + description: '[Output-only] Text of the current statement/expression.' + readOnly: true + type: string + type: object + ScriptStatistics: + properties: + evaluationKind: + description: '[Output-only] Whether this child job was a statement or expression.' + readOnly: true + type: string + stackFrames: + description: Stack trace showing the line/column/procedure name of each + frame on the stack at the point where the current evaluation happened. + The leaf frame is first, the primary script is last. Never empty. + items: + $ref: '#/components/schemas/ScriptStackFrame' + type: array + type: object + SessionInfo: + properties: + sessionId: + description: '[Output-only] // [Preview] Id of the session.' + readOnly: true + type: string + type: object + SetIamPolicyRequest: + description: Request message for `SetIamPolicy` method. + properties: + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the `resource`. + The size of the policy is limited to a few 10s of KB. An empty policy + is a valid policy but certain Cloud Platform services (such as Projects) + might reject them.' + updateMask: + description: 'OPTIONAL: A FieldMask specifying which fields of the policy + to modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, etag"`' + format: google-fieldmask + type: string + type: object + SnapshotDefinition: + properties: + baseTableReference: + $ref: '#/components/schemas/TableReference' + description: '[Required] Reference describing the ID of the table that was + snapshot.' + snapshotTime: + description: '[Required] The time at which the base table was snapshot. + This value is reported in the JSON response using RFC3339 format.' + format: date-time + type: string + required: + - baseTableReference + - snapshotTime + type: object + StandardSqlDataType: + description: 'The type of a variable, e.g., a function argument. Examples: INT64: + {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} + STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, + {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}' + properties: + arrayElementType: + $ref: '#/components/schemas/StandardSqlDataType' + description: The type of the array's elements, if type_kind = "ARRAY". + structType: + $ref: '#/components/schemas/StandardSqlStructType' + description: The fields of this struct, in order, if type_kind = "STRUCT". + typeKind: + description: Required. The top level type of this field. Can be any standard + SQL data type (e.g., "INT64", "DATE", "ARRAY"). + enum: + - TYPE_KIND_UNSPECIFIED + - INT64 + - BOOL + - FLOAT64 + - STRING + - BYTES + - TIMESTAMP + - DATE + - TIME + - DATETIME + - INTERVAL + - GEOGRAPHY + - NUMERIC + - BIGNUMERIC + - JSON + - ARRAY + - STRUCT + type: string + type: object + StandardSqlField: + description: A field or a column. + properties: + name: + description: Optional. The name of this field. Can be absent for struct + fields. + type: string + type: + $ref: '#/components/schemas/StandardSqlDataType' + description: Optional. The type of this parameter. Absent if not explicitly + specified (e.g., CREATE FUNCTION statement can omit the return type; in + this case the output parameter does not have this "type" field). + type: object + StandardSqlStructType: + properties: + fields: + items: + $ref: '#/components/schemas/StandardSqlField' + type: array + type: object + StandardSqlTableType: + description: A table type + properties: + columns: + description: The columns in this table type + items: + $ref: '#/components/schemas/StandardSqlField' + type: array + type: object + Streamingbuffer: + properties: + estimatedBytes: + description: '[Output-only] A lower-bound estimate of the number of bytes + currently in the streaming buffer.' + format: uint64 + readOnly: true + type: string + estimatedRows: + description: '[Output-only] A lower-bound estimate of the number of rows + currently in the streaming buffer.' + format: uint64 + readOnly: true + type: string + oldestEntryTime: + description: '[Output-only] Contains the timestamp of the oldest entry in + the streaming buffer, in milliseconds since the epoch, if the streaming + buffer is available.' + format: uint64 + readOnly: true + type: string + type: object + Table: + properties: + clustering: + $ref: '#/components/schemas/Clustering' + description: '[Beta] Clustering specification for the table. Must be specified + with partitioning, data in the table will be first partitioned and subsequently + clustered.' + creationTime: + description: '[Output-only] The time when this table was created, in milliseconds + since the epoch.' + format: int64 + readOnly: true + type: string + defaultCollation: + description: '[Output-only] The default collation of the table.' + readOnly: true + type: string + description: + description: '[Optional] A user-friendly description of this table.' + type: string + encryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: Custom encryption configuration (e.g., Cloud KMS keys). + etag: + description: '[Output-only] A hash of the table metadata. Used to ensure + there were no concurrent modifications to the resource when attempting + an update. Not guaranteed to change when the table contents or the fields + numRows, numBytes, numLongTermBytes or lastModifiedTime change.' + readOnly: true + type: string + expirationTime: + description: '[Optional] The time when this table expires, in milliseconds + since the epoch. If not present, the table will persist indefinitely. + Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs + property of the encapsulating dataset can be used to set a default expirationTime + on newly created tables.' + format: int64 + type: string + externalDataConfiguration: + $ref: '#/components/schemas/ExternalDataConfiguration' + description: '[Optional] Describes the data format, location, and other + properties of a table stored outside of BigQuery. By defining these properties, + the data source can then be queried as if it were a standard BigQuery + table.' + friendlyName: + description: '[Optional] A descriptive name for this table.' + type: string + id: + description: '[Output-only] An opaque ID uniquely identifying the table.' + readOnly: true + type: string + kind: + default: bigquery#table + description: '[Output-only] The type of the resource.' + readOnly: true + type: string + labels: + additionalProperties: + type: string + description: The labels associated with this table. You can use these to + organize and group your tables. Label keys and values can be no longer + than 63 characters, can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. Label values + are optional. Label keys must start with a letter and each label in the + list must have a different key. + type: object + lastModifiedTime: + description: '[Output-only] The time when this table was last modified, + in milliseconds since the epoch.' + format: uint64 + readOnly: true + type: string + location: + description: '[Output-only] The geographic location where the table resides. + This value is inherited from the dataset.' + readOnly: true + type: string + materializedView: + $ref: '#/components/schemas/MaterializedViewDefinition' + description: '[Optional] Materialized view definition.' + model: + $ref: '#/components/schemas/ModelDefinition' + description: '[Output-only, Beta] Present iff this table represents a ML + model. Describes the training information for the model, and it is required + to run ''PREDICT'' queries.' + numBytes: + description: '[Output-only] The size of this table in bytes, excluding any + data in the streaming buffer.' + format: int64 + readOnly: true + type: string + numLongTermBytes: + description: '[Output-only] The number of bytes in the table that are considered + "long-term storage".' + format: int64 + readOnly: true + type: string + numPhysicalBytes: + description: '[Output-only] [TrustedTester] The physical size of this table + in bytes, excluding any data in the streaming buffer. This includes compression + and storage used for time travel.' + format: int64 + readOnly: true + type: string + numRows: + description: '[Output-only] The number of rows of data in this table, excluding + any data in the streaming buffer.' + format: uint64 + readOnly: true + type: string + rangePartitioning: + $ref: '#/components/schemas/RangePartitioning' + description: '[TrustedTester] Range partitioning specification for this + table. Only one of timePartitioning and rangePartitioning should be specified.' + requirePartitionFilter: + default: false + description: '[Optional] If set to true, queries over this table require + a partition filter that can be used for partition elimination to be specified.' + type: boolean + schema: + $ref: '#/components/schemas/TableSchema' + description: '[Optional] Describes the schema of this table.' + selfLink: + description: '[Output-only] A URL that can be used to access this resource + again.' + readOnly: true + type: string + snapshotDefinition: + $ref: '#/components/schemas/SnapshotDefinition' + description: '[Output-only] Snapshot definition.' + readOnly: true + streamingBuffer: + $ref: '#/components/schemas/Streamingbuffer' + description: '[Output-only] Contains information regarding this table''s + streaming buffer, if one is present. This field will be absent if the + table is not being streamed to or if there is no data in the streaming + buffer.' + readOnly: true + tableReference: + $ref: '#/components/schemas/TableReference' + description: '[Required] Reference describing the ID of this table.' + timePartitioning: + $ref: '#/components/schemas/TimePartitioning' + description: Time-based partitioning specification for this table. Only + one of timePartitioning and rangePartitioning should be specified. + type: + description: '[Output-only] Describes the table type. The following values + are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined + by a SQL query. SNAPSHOT: An immutable, read-only table that is a copy + of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result + is persisted. EXTERNAL: A table that references data stored in an external + storage system, such as Google Cloud Storage. The default value is TABLE.' + readOnly: true + type: string + view: + $ref: '#/components/schemas/ViewDefinition' + description: '[Optional] The view definition.' + required: + - tableReference + type: object + TableCell: + properties: + v: {} + type: object + TableDataInsertAllRequest: + properties: + ignoreUnknownValues: + description: '[Optional] Accept rows that contain values that do not match + the schema. The unknown values are ignored. Default is false, which treats + unknown values as errors.' + type: boolean + kind: + default: bigquery#tableDataInsertAllRequest + description: The resource type of the response. + type: string + rows: + description: The rows to insert. + items: + properties: + insertId: + description: '[Optional] A unique ID for each row. BigQuery uses this + property to detect duplicate insertion requests on a best-effort + basis.' + type: string + json: + $ref: '#/components/schemas/JsonObject' + description: '[Required] A JSON object that contains a row of data. + The object''s properties and values must match the destination table''s + schema.' + type: object + type: array + skipInvalidRows: + description: '[Optional] Insert all valid rows of a request, even if invalid + rows exist. The default value is false, which causes the entire request + to fail if any invalid rows exist.' + type: boolean + templateSuffix: + description: If specified, treats the destination table as a base template, + and inserts the rows into an instance table named "{destination}{templateSuffix}". + BigQuery will manage creation of the instance table, using the schema + of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables + for considerations when working with templates tables. + type: string + type: object + TableDataInsertAllResponse: + properties: + insertErrors: + description: An array of errors for rows that were not inserted. + items: + properties: + errors: + description: Error information for the row indicated by the index + property. + items: + $ref: '#/components/schemas/ErrorProto' + type: array + index: + description: The index of the row that error applies to. + format: uint32 + type: integer + type: object + type: array + kind: + default: bigquery#tableDataInsertAllResponse + description: The resource type of the response. + type: string + type: object + TableDataList: + properties: + etag: + description: A hash of this page of results. + type: string + kind: + default: bigquery#tableDataList + description: The resource type of the response. + type: string + pageToken: + description: A token used for paging results. Providing this token instead + of the startIndex parameter can help you retrieve stable results when + an underlying table is changing. + type: string + rows: + description: Rows of results. + items: + $ref: '#/components/schemas/TableRow' + type: array + totalRows: + description: The total number of rows in the complete table. + format: int64 + type: string + type: object + TableFieldSchema: + properties: + categories: + description: '[Optional] The categories attached to this field, used for + field-level access control.' + properties: + names: + description: A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". + At most 5 categories are allowed. + items: + type: string + type: array + type: object + collationSpec: + description: Optional. Collation specification of the field. It only can + be set on string type field. + type: string + description: + description: '[Optional] The field description. The maximum length is 1,024 + characters.' + type: string + fields: + description: '[Optional] Describes the nested schema fields if the type + property is set to RECORD.' + items: + $ref: '#/components/schemas/TableFieldSchema' + type: array + maxLength: + description: "[Optional] Maximum length of values of this field for STRINGS\ + \ or BYTES. If max_length is not specified, no maximum length constraint\ + \ is imposed on this field. If type = \"STRING\", then max_length represents\ + \ the maximum UTF-8 length of strings in this field. If type = \"BYTES\"\ + , then max_length represents the maximum number of bytes in this field.\ + \ It is invalid to set this field if type \u2260 \"STRING\" and \u2260\ + \ \"BYTES\"." + format: int64 + type: string + mode: + description: '[Optional] The field mode. Possible values include NULLABLE, + REQUIRED and REPEATED. The default value is NULLABLE.' + type: string + name: + description: '[Required] The field name. The name must contain only letters + (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter + or underscore. The maximum length is 300 characters.' + type: string + policyTags: + properties: + names: + description: A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". + At most 1 policy tag is allowed. + items: + type: string + type: array + type: object + precision: + description: "[Optional] Precision (maximum number of total digits in base\ + \ 10) and scale (maximum number of digits in the fractional part in base\ + \ 10) constraints for values of this field for NUMERIC or BIGNUMERIC.\ + \ It is invalid to set precision or scale if type \u2260 \"NUMERIC\" and\ + \ \u2260 \"BIGNUMERIC\". If precision and scale are not specified, no\ + \ value range constraint is imposed on this field insofar as values are\ + \ permitted by the type. Values of this NUMERIC or BIGNUMERIC field must\ + \ be in this range when: - Precision (P) and scale (S) are specified:\ + \ [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale\ + \ (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P\ + \ - 1]. Acceptable values for precision and scale if both are specified:\ + \ - If type = \"NUMERIC\": 1 \u2264 precision - scale \u2264 29 and 0\ + \ \u2264 scale \u2264 9. - If type = \"BIGNUMERIC\": 1 \u2264 precision\ + \ - scale \u2264 38 and 0 \u2264 scale \u2264 38. Acceptable values for\ + \ precision if only precision is specified but not scale (and thus scale\ + \ is interpreted to be equal to zero): - If type = \"NUMERIC\": 1 \u2264\ + \ precision \u2264 29. - If type = \"BIGNUMERIC\": 1 \u2264 precision\ + \ \u2264 38. If scale is specified but not precision, then it is invalid." + format: int64 + type: string + scale: + description: '[Optional] See documentation for precision.' + format: int64 + type: string + type: + description: '[Required] The field data type. Possible values include STRING, + BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), + NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, + TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field + contains a nested schema) or STRUCT (same as RECORD).' + type: string + required: + - name + - type + type: object + TableList: + properties: + etag: + description: A hash of this page of results. + type: string + kind: + default: bigquery#tableList + description: The type of list. + type: string + nextPageToken: + description: A token to request the next page of results. + type: string + tables: + description: Tables in the requested dataset. + items: + properties: + clustering: + $ref: '#/components/schemas/Clustering' + description: '[Beta] Clustering specification for this table, if configured.' + creationTime: + description: The time when this table was created, in milliseconds + since the epoch. + format: int64 + type: string + expirationTime: + description: '[Optional] The time when this table expires, in milliseconds + since the epoch. If not present, the table will persist indefinitely. + Expired tables will be deleted and their storage reclaimed.' + format: int64 + type: string + friendlyName: + description: The user-friendly name for this table. + type: string + id: + description: An opaque ID of the table + type: string + kind: + default: bigquery#table + description: The resource type. + type: string + labels: + additionalProperties: + type: string + description: The labels associated with this table. You can use these + to organize and group your tables. + type: object + rangePartitioning: + $ref: '#/components/schemas/RangePartitioning' + description: The range partitioning specification for this table, + if configured. + tableReference: + $ref: '#/components/schemas/TableReference' + description: A reference uniquely identifying the table. + timePartitioning: + $ref: '#/components/schemas/TimePartitioning' + description: The time-based partitioning specification for this table, + if configured. + type: + description: 'The type of table. Possible values are: TABLE, VIEW.' + type: string + view: + description: Additional details for a view. + properties: + useLegacySql: + description: True if view is defined in legacy SQL dialect, false + if in standard SQL. + type: boolean + type: object + type: object + type: array + totalItems: + description: The total number of tables in the dataset. + format: int32 + type: integer + type: object + TableReference: + properties: + datasetId: + description: '[Required] The ID of the dataset containing this table.' + type: string + projectId: + description: '[Required] The ID of the project containing this table.' + type: string + tableId: + description: '[Required] The ID of the table. The ID must contain only letters + (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 + characters.' + type: string + required: + - datasetId + - projectId + - tableId + type: object + TableRow: + properties: + f: + description: Represents a single row in the result set, consisting of one + or more fields. + items: + $ref: '#/components/schemas/TableCell' + type: array + type: object + TableSchema: + properties: + fields: + description: Describes the fields in a table. + items: + $ref: '#/components/schemas/TableFieldSchema' + type: array + type: object + TestIamPermissionsRequest: + description: Request message for `TestIamPermissions` method. + properties: + permissions: + description: The set of permissions to check for the `resource`. Permissions + with wildcards (such as '*' or 'storage.*') are not allowed. For more + information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + items: + type: string + type: array + type: object + TestIamPermissionsResponse: + description: Response message for `TestIamPermissions` method. + properties: + permissions: + description: A subset of `TestPermissionsRequest.permissions` that the caller + is allowed. + items: + type: string + type: array + type: object + TimePartitioning: + properties: + expirationMs: + description: '[Optional] Number of milliseconds for which to keep the storage + for partitions in the table. The storage in a partition will have an expiration + time of its partition time plus this value.' + format: int64 + type: string + field: + description: '[Beta] [Optional] If not set, the table is partitioned by + pseudo column, referenced via either ''_PARTITIONTIME'' as TIMESTAMP type, + or ''_PARTITIONDATE'' as DATE type. If field is specified, the table is + instead partitioned by this field. The field must be a top-level TIMESTAMP + or DATE field. Its mode must be NULLABLE or REQUIRED.' + type: string + requirePartitionFilter: + type: boolean + type: + description: '[Required] The supported types are DAY, HOUR, MONTH, and YEAR, + which will generate one partition per day, hour, month, and year, respectively. + When the type is not specified, the default behavior is DAY.' + type: string + required: + - type + type: object + TrainingOptions: + description: Options used in model training. + properties: + adjustStepChanges: + description: If true, detect step changes and make data adjustment in the + input time series. + type: boolean + autoArima: + description: Whether to enable auto ARIMA or not. + type: boolean + autoArimaMaxOrder: + description: The max value of non-seasonal p and q. + format: int64 + type: string + batchSize: + description: Batch size for dnn models. + format: int64 + type: string + boosterType: + description: Booster type for boosted tree models. + enum: + - BOOSTER_TYPE_UNSPECIFIED + - GBTREE + - DART + type: string + cleanSpikesAndDips: + description: If true, clean spikes and dips in the input time series. + type: boolean + colsampleBylevel: + description: Subsample ratio of columns for each level for boosted tree + models. + format: double + type: number + colsampleBynode: + description: Subsample ratio of columns for each node(split) for boosted + tree models. + format: double + type: number + colsampleBytree: + description: Subsample ratio of columns when constructing each tree for + boosted tree models. + format: double + type: number + dartNormalizeType: + description: Type of normalization algorithm for boosted tree models using + dart booster. + enum: + - DART_NORMALIZE_TYPE_UNSPECIFIED + - TREE + - FOREST + type: string + dataFrequency: + description: The data frequency of a time series. + enum: + - DATA_FREQUENCY_UNSPECIFIED + - AUTO_FREQUENCY + - YEARLY + - QUARTERLY + - MONTHLY + - WEEKLY + - DAILY + - HOURLY + - PER_MINUTE + type: string + dataSplitColumn: + description: 'The column to split data with. This column won''t be used + as a feature. 1. When data_split_method is CUSTOM, the corresponding column + should be boolean. The rows with true value tag are eval data, and the + false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION + rows (from smallest to largest) in the corresponding column are used as + training data, and the rest are eval data. It respects the order in Orderable + data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties' + type: string + dataSplitEvalFraction: + description: The fraction of evaluation data over the whole input data. + The rest of data will be used as training data. The format should be double. + Accurate to two decimal places. Default value is 0.2. + format: double + type: number + dataSplitMethod: + description: The data split type for training and evaluation, e.g. RANDOM. + enum: + - DATA_SPLIT_METHOD_UNSPECIFIED + - RANDOM + - CUSTOM + - SEQUENTIAL + - NO_SPLIT + - AUTO_SPLIT + type: string + decomposeTimeSeries: + description: If true, perform decompose time series and save the results. + type: boolean + distanceType: + description: Distance type for clustering models. + enum: + - DISTANCE_TYPE_UNSPECIFIED + - EUCLIDEAN + - COSINE + type: string + dropout: + description: Dropout probability for dnn models. + format: double + type: number + earlyStop: + description: Whether to stop early when the loss doesn't improve significantly + any more (compared to min_relative_progress). Used only for iterative + training algorithms. + type: boolean + feedbackType: + description: Feedback type that specifies which algorithm to run for matrix + factorization. + enum: + - FEEDBACK_TYPE_UNSPECIFIED + - IMPLICIT + - EXPLICIT + type: string + hiddenUnits: + description: Hidden units for dnn models. + items: + format: int64 + type: string + type: array + holidayRegion: + description: The geographical region based on which the holidays are considered + in time series modeling. If a valid value is specified, then holiday effects + modeling is enabled. + enum: + - HOLIDAY_REGION_UNSPECIFIED + - GLOBAL + - NA + - JAPAC + - EMEA + - LAC + - AE + - AR + - AT + - AU + - BE + - BR + - CA + - CH + - CL + - CN + - CO + - CS + - CZ + - DE + - DK + - DZ + - EC + - EE + - EG + - ES + - FI + - FR + - GB + - GR + - HK + - HU + - ID + - IE + - IL + - IN + - IR + - IT + - JP + - KR + - LV + - MA + - MX + - MY + - NG + - NL + - false + - NZ + - PE + - PH + - PK + - PL + - PT + - RO + - RS + - RU + - SA + - SE + - SG + - SI + - SK + - TH + - TR + - TW + - UA + - US + - VE + - VN + - ZA + type: string + horizon: + description: The number of periods ahead that need to be forecasted. + format: int64 + type: string + includeDrift: + description: Include drift when fitting an ARIMA model. + type: boolean + initialLearnRate: + description: Specifies the initial learning rate for the line search learn + rate strategy. + format: double + type: number + inputLabelColumns: + description: Name of input label columns in training data. + items: + type: string + type: array + itemColumn: + description: Item column specified for matrix factorization models. + type: string + kmeansInitializationColumn: + description: The column used to provide the initial centroids for kmeans + algorithm when kmeans_initialization_method is CUSTOM. + type: string + kmeansInitializationMethod: + description: The method used to initialize the centroids for kmeans algorithm. + enum: + - KMEANS_INITIALIZATION_METHOD_UNSPECIFIED + - RANDOM + - CUSTOM + - KMEANS_PLUS_PLUS + type: string + l1Regularization: + description: L1 regularization coefficient. + format: double + type: number + l2Regularization: + description: L2 regularization coefficient. + format: double + type: number + labelClassWeights: + additionalProperties: + format: double + type: number + description: Weights associated with each label class, for rebalancing the + training data. Only applicable for classification models. + type: object + learnRate: + description: Learning rate in training. Used only for iterative training + algorithms. + format: double + type: number + learnRateStrategy: + description: The strategy to determine learn rate for the current iteration. + enum: + - LEARN_RATE_STRATEGY_UNSPECIFIED + - LINE_SEARCH + - CONSTANT + type: string + lossType: + description: Type of loss function used during training run. + enum: + - LOSS_TYPE_UNSPECIFIED + - MEAN_SQUARED_LOSS + - MEAN_LOG_LOSS + type: string + maxIterations: + description: The maximum number of iterations in training. Used only for + iterative training algorithms. + format: int64 + type: string + maxTreeDepth: + description: Maximum depth of a tree for boosted tree models. + format: int64 + type: string + minRelativeProgress: + description: When early_stop is true, stops training when accuracy improvement + is less than 'min_relative_progress'. Used only for iterative training + algorithms. + format: double + type: number + minSplitLoss: + description: Minimum split loss for boosted tree models. + format: double + type: number + minTreeChildWeight: + description: Minimum sum of instance weight needed in a child for boosted + tree models. + format: int64 + type: string + modelUri: + description: Google Cloud Storage URI from which the model was imported. + Only applicable for imported models. + type: string + nonSeasonalOrder: + $ref: '#/components/schemas/ArimaOrder' + description: 'A specification of the non-seasonal part of the ARIMA model: + the three components (p, d, q) are the AR order, the degree of differencing, + and the MA order.' + numClusters: + description: Number of clusters for clustering models. + format: int64 + type: string + numFactors: + description: Num factors specified for matrix factorization models. + format: int64 + type: string + numParallelTree: + description: Number of parallel trees constructed during each iteration + for boosted tree models. + format: int64 + type: string + optimizationStrategy: + description: Optimization strategy for training linear regression models. + enum: + - OPTIMIZATION_STRATEGY_UNSPECIFIED + - BATCH_GRADIENT_DESCENT + - NORMAL_EQUATION + type: string + preserveInputStructs: + description: Whether to preserve the input structs in output feature names. + Suppose there is a struct A with field b. When false (default), the output + feature name is A_b. When true, the output feature name is A.b. + type: boolean + subsample: + description: Subsample fraction of the training data to grow tree to prevent + overfitting for boosted tree models. + format: double + type: number + timeSeriesDataColumn: + description: Column to be designated as time series data for ARIMA model. + type: string + timeSeriesIdColumn: + description: The time series id column that was used during ARIMA model + training. + type: string + timeSeriesIdColumns: + description: The time series id columns that were used during ARIMA model + training. + items: + type: string + type: array + timeSeriesTimestampColumn: + description: Column to be designated as time series timestamp for ARIMA + model. + type: string + treeMethod: + description: Tree construction algorithm for boosted tree models. + enum: + - TREE_METHOD_UNSPECIFIED + - AUTO + - EXACT + - APPROX + - HIST + type: string + userColumn: + description: User column specified for matrix factorization models. + type: string + walsAlpha: + description: Hyperparameter for matrix factoration when implicit feedback + type is specified. + format: double + type: number + warmStart: + description: Whether to train a model from the last checkpoint. + type: boolean + type: object + TrainingRun: + description: Information about a single training query run for the model. + properties: + dataSplitResult: + $ref: '#/components/schemas/DataSplitResult' + description: Data split result of the training run. Only set when the input + data is actually split. + evaluationMetrics: + $ref: '#/components/schemas/EvaluationMetrics' + description: The evaluation metrics over training/eval data that were computed + at the end of training. + results: + description: Output of each iteration run, results.size() <= max_iterations. + items: + $ref: '#/components/schemas/IterationResult' + type: array + startTime: + description: The start time of this training run. + format: google-datetime + type: string + trainingOptions: + $ref: '#/components/schemas/TrainingOptions' + description: Options that were used for this training run, includes user + specified and default options that were used. + type: object + TransactionInfo: + properties: + transactionId: + description: '[Output-only] // [Alpha] Id of the transaction.' + readOnly: true + type: string + type: object + UserDefinedFunctionResource: + description: 'This is used for defining User Defined Function (UDF) resources + only when using legacy SQL. Users of Standard SQL should leverage either DDL + (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF + resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions' + properties: + inlineCode: + description: '[Pick one] An inline resource that contains code for a user-defined + function (UDF). Providing a inline code resource is equivalent to providing + a URI for a file containing the same code.' + type: string + resourceUri: + description: '[Pick one] A code resource to load from a Google Cloud Storage + URI (gs://bucket/path).' + type: string + type: object + ViewDefinition: + properties: + query: + description: '[Required] A query that BigQuery executes when the view is + referenced.' + type: string + useExplicitColumnNames: + description: 'True if the column names are explicitly specified. For example + by using the ''CREATE VIEW v(c1, c2) AS ...'' syntax. Can only be set + using BigQuery''s standard SQL: https://cloud.google.com/bigquery/sql-reference/' + type: boolean + useLegacySql: + description: 'Specifies whether to use BigQuery''s legacy SQL for this view. + The default value is true. If set to false, the view will use BigQuery''s + standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries + and views that reference this view must use the same flag value.' + type: boolean + userDefinedFunctionResources: + description: Describes user-defined function resources used in the query. + items: + $ref: '#/components/schemas/UserDefinedFunctionResource' + type: array + required: + - query + type: object + securitySchemes: + Oauth2: + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/bigquery: View and manage your data in + Google BigQuery and see the email address for your Google Account + https://www.googleapis.com/auth/bigquery.insertdata: Insert data into + Google BigQuery + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + https://www.googleapis.com/auth/cloud-platform.read-only: View your data + across Google Cloud services and see the email address of your Google + Account + https://www.googleapis.com/auth/devstorage.full_control: Manage your data + and permissions in Cloud Storage and see the email address for your + Google Account + https://www.googleapis.com/auth/devstorage.read_only: View your data in + Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_write: Manage your data + in Cloud Storage and see the email address of your Google Account + type: oauth2 + Oauth2c: + description: Oauth 2.0 authorizationCode authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/bigquery: View and manage your data in + Google BigQuery and see the email address for your Google Account + https://www.googleapis.com/auth/bigquery.insertdata: Insert data into + Google BigQuery + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + https://www.googleapis.com/auth/cloud-platform.read-only: View your data + across Google Cloud services and see the email address of your Google + Account + https://www.googleapis.com/auth/devstorage.full_control: Manage your data + and permissions in Cloud Storage and see the email address for your + Google Account + https://www.googleapis.com/auth/devstorage.read_only: View your data in + Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_write: Manage your data + in Cloud Storage and see the email address of your Google Account + tokenUrl: https://accounts.google.com/o/oauth2/token + type: oauth2 + x-stackQL-resources: + datasets: + id: google.bigquery.datasets + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{projectId}/datasets/{datasetId} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{projectId}/datasets/{datasetId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{projectId}/datasets + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{projectId}/datasets + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{projectId}/datasets/{datasetId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{projectId}/datasets/{datasetId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: datasets + title: datasets + jobs: + id: google.bigquery.jobs + methods: + cancel: + operation: + $ref: post + path: + $ref: /projects/{projectId}/jobs/{jobId}/cancel + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{projectsId}/jobs/{jobsId}/delete + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{projectId}/jobs/{jobId} + response: + mediaType: application/json + openAPIDocKey: '200' + getQueryResults: + operation: + $ref: get + path: + $ref: /projects/{projectId}/queries/{jobId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{projectId}/jobs + request: + mediaType: application/octet-stream + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{projectId}/jobs + response: + mediaType: application/json + openAPIDocKey: '200' + query: + operation: + $ref: post + path: + $ref: /projects/{projectId}/queries + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: jobs + title: jobs + models: + id: google.bigquery.models + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/models/{modelsId} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/models/{modelsId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/models + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/models/{modelsId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: models + title: models + projects: + id: google.bigquery.projects + methods: + getServiceAccount: + operation: + $ref: get + path: + $ref: /projects/{projectId}/serviceAccount + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects + title: projects + routines: + id: google.bigquery.routines + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/routines + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/routines + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: routines + title: routines + rowAccessPolicies: + id: google.bigquery.rowAccessPolicies + methods: + getIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:getIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: rowAccessPolicies + title: rowAccessPolicies + tabledata: + id: google.bigquery.tabledata + methods: + insertAll: + operation: + $ref: post + path: + $ref: /projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data + response: + mediaType: application/json + openAPIDocKey: '200' + name: tabledata + title: tabledata + tables: + id: google.bigquery.tables + methods: + delete: + operation: + $ref: delete + path: + $ref: /projects/{projectId}/datasets/{datasetId}/tables/{tableId} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{projectId}/datasets/{datasetId}/tables/{tableId} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:getIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /projects/{projectId}/datasets/{datasetId}/tables + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{projectId}/datasets/{datasetId}/tables + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /projects/{projectId}/datasets/{datasetId}/tables/{tableId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{projectId}/datasets/{datasetId}/tables/{tableId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: tables + title: tables +externalDocs: + url: https://cloud.google.com/bigquery/ +info: + contact: + name: Google + url: https://google.com + x-twitter: youtube + description: A data platform for customers to create, manage, share and query data. + license: + name: Creative Commons Attribution 3.0 + url: http://creativecommons.org/licenses/by/3.0/ + termsOfService: https://developers.google.com/terms/ + title: BigQuery API + version: v2 + x-apiClientRegistration: + url: https://console.developers.google.com + x-apisguru-categories: + - analytics + - media + x-logo: + url: https://api.apis.guru/v2/cache/logo/https_www.google.com_images_branding_googlelogo_2x_googlelogo_color_272x92dp.png + x-origin: + - format: openapi + url: https://bigquery.googleapis.com/$discovery/rest?version=v2 + version: '3.0' + x-providerName: googleapis.com + x-serviceName: bigquery +openapi: 3.0.0 +paths: + /projects: + get: + description: Lists all projects to which you have been granted any project role. + operationId: bigquery.projects.list + parameters: + - description: Maximum number of results to return + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call, to request the next + page of results + in: query + name: pageToken + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - projects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectId}/datasets: + get: + description: Lists all datasets in the specified project to which you have been + granted the READER dataset role. + operationId: bigquery.datasets.list + parameters: + - description: Project ID of the datasets to be listed + in: path + name: projectId + required: true + schema: + type: string + - description: Whether to list all datasets, including hidden ones + in: query + name: all + schema: + type: boolean + - description: 'An expression for filtering the results of the request by label. + The syntax is "labels.[:]". Multiple filters can be ANDed together + by connecting with a space. Example: "labels.department:receiving labels.active". + See Filtering datasets using labels for details.' + in: query + name: filter + schema: + type: string + - description: The maximum number of results to return + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call, to request the next + page of results + in: query + name: pageToken + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DatasetList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - datasets + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new empty dataset. + operationId: bigquery.datasets.insert + parameters: + - description: Project ID of the new dataset + in: path + name: projectId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - datasets + /projects/{projectId}/datasets/{datasetId}: + delete: + description: Deletes the dataset specified by the datasetId value. Before you + can delete a dataset, you must delete all its tables, either manually or by + specifying deleteContents. Immediately after deletion, you can create another + dataset with the same name. + operationId: bigquery.datasets.delete + parameters: + - description: Project ID of the dataset being deleted + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of dataset being deleted + in: path + name: datasetId + required: true + schema: + type: string + - description: If True, delete all the tables in the dataset. If False and the + dataset contains tables, the request will fail. Default is False + in: query + name: deleteContents + schema: + type: boolean + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - datasets + get: + description: Returns the dataset specified by datasetID. + operationId: bigquery.datasets.get + parameters: + - description: Project ID of the requested dataset + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the requested dataset + in: path + name: datasetId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - datasets + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates information in an existing dataset. The update method replaces + the entire dataset resource, whereas the patch method only replaces fields + that are provided in the submitted dataset resource. This method supports + patch semantics. + operationId: bigquery.datasets.patch + parameters: + - description: Project ID of the dataset being updated + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the dataset being updated + in: path + name: datasetId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - datasets + put: + description: Updates information in an existing dataset. The update method replaces + the entire dataset resource, whereas the patch method only replaces fields + that are provided in the submitted dataset resource. + operationId: bigquery.datasets.update + parameters: + - description: Project ID of the dataset being updated + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the dataset being updated + in: path + name: datasetId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - datasets + /projects/{projectId}/datasets/{datasetId}/models: + get: + description: Lists all models in the specified dataset. Requires the READER + dataset role. After retrieving the list of models, you can get information + about a particular model by calling the models.get method. + operationId: bigquery.models.list + parameters: + - description: Required. Project ID of the models to list. + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the models to list. + in: path + name: datasetId + required: true + schema: + type: string + - description: The maximum number of results to return in a single response + page. Leverage the page tokens to iterate through the entire collection. + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call to request the next page + of results + in: query + name: pageToken + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListModelsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - models + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectId}/datasets/{datasetId}/models/{modelId}: + delete: + description: Deletes the model specified by modelId from the dataset. + operationId: bigquery.models.delete + parameters: + - description: Required. Project ID of the model to delete. + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the model to delete. + in: path + name: datasetId + required: true + schema: + type: string + - description: Required. Model ID of the model to delete. + in: path + name: modelId + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - models + get: + description: Gets the specified model resource by model ID. + operationId: bigquery.models.get + parameters: + - description: Required. Project ID of the requested model. + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the requested model. + in: path + name: datasetId + required: true + schema: + type: string + - description: Required. Model ID of the requested model. + in: path + name: modelId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - models + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Patch specific fields in the specified model. + operationId: bigquery.models.patch + parameters: + - description: Required. Project ID of the model to patch. + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the model to patch. + in: path + name: datasetId + required: true + schema: + type: string + - description: Required. Model ID of the model to patch. + in: path + name: modelId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - models + /projects/{projectId}/datasets/{datasetId}/routines: + get: + description: Lists all routines in the specified dataset. Requires the READER + dataset role. + operationId: bigquery.routines.list + parameters: + - description: Required. Project ID of the routines to list + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the routines to list + in: path + name: datasetId + required: true + schema: + type: string + - description: 'If set, then only the Routines matching this filter are returned. + The current supported form is either "routine_type:" or "routineType:", + where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION".' + in: query + name: filter + schema: + type: string + - description: The maximum number of results to return in a single response + page. Leverage the page tokens to iterate through the entire collection. + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call, to request the next + page of results + in: query + name: pageToken + schema: + type: string + - description: 'If set, then only the Routine fields in the field mask, as well + as project_id, dataset_id and routine_id, are returned in the response. + If unset, then the following Routine fields are returned: etag, project_id, + dataset_id, routine_id, routine_type, creation_time, last_modified_time, + and language.' + in: query + name: readMask + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListRoutinesResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - routines + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new routine in the dataset. + operationId: bigquery.routines.insert + parameters: + - description: Required. Project ID of the new routine + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the new routine + in: path + name: datasetId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - routines + /projects/{projectId}/datasets/{datasetId}/routines/{routineId}: + delete: + description: Deletes the routine specified by routineId from the dataset. + operationId: bigquery.routines.delete + parameters: + - description: Required. Project ID of the routine to delete + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the routine to delete + in: path + name: datasetId + required: true + schema: + type: string + - description: Required. Routine ID of the routine to delete + in: path + name: routineId + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - routines + get: + description: Gets the specified routine resource by routine ID. + operationId: bigquery.routines.get + parameters: + - description: Required. Project ID of the requested routine + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the requested routine + in: path + name: datasetId + required: true + schema: + type: string + - description: Required. Routine ID of the requested routine + in: path + name: routineId + required: true + schema: + type: string + - description: If set, only the Routine fields in the field mask are returned + in the response. If unset, all Routine fields are returned. + in: query + name: readMask + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - routines + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + put: + description: Updates information in an existing routine. The update method replaces + the entire Routine resource. + operationId: bigquery.routines.update + parameters: + - description: Required. Project ID of the routine to update + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of the routine to update + in: path + name: datasetId + required: true + schema: + type: string + - description: Required. Routine ID of the routine to update + in: path + name: routineId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - routines + /projects/{projectId}/datasets/{datasetId}/tables: + get: + description: Lists all tables in the specified dataset. Requires the READER + dataset role. + operationId: bigquery.tables.list + parameters: + - description: Project ID of the tables to list + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the tables to list + in: path + name: datasetId + required: true + schema: + type: string + - description: Maximum number of results to return + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call, to request the next + page of results + in: query + name: pageToken + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TableList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tables + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new, empty table in the dataset. + operationId: bigquery.tables.insert + parameters: + - description: Project ID of the new table + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the new table + in: path + name: datasetId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tables + /projects/{projectId}/datasets/{datasetId}/tables/{tableId}: + delete: + description: Deletes the table specified by tableId from the dataset. If the + table contains data, all the data will be deleted. + operationId: bigquery.tables.delete + parameters: + - description: Project ID of the table to delete + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the table to delete + in: path + name: datasetId + required: true + schema: + type: string + - description: Table ID of the table to delete + in: path + name: tableId + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tables + get: + description: Gets the specified table resource by table ID. This method does + not return the data in the table, it only returns the table resource, which + describes the structure of this table. + operationId: bigquery.tables.get + parameters: + - description: Project ID of the requested table + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the requested table + in: path + name: datasetId + required: true + schema: + type: string + - description: Table ID of the requested table + in: path + name: tableId + required: true + schema: + type: string + - description: List of fields to return (comma-separated). If unspecified, all + fields are returned + in: query + name: selectedFields + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tables + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Updates information in an existing table. The update method replaces + the entire table resource, whereas the patch method only replaces fields that + are provided in the submitted table resource. This method supports patch semantics. + operationId: bigquery.tables.patch + parameters: + - description: Project ID of the table to update + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the table to update + in: path + name: datasetId + required: true + schema: + type: string + - description: Table ID of the table to update + in: path + name: tableId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tables + put: + description: Updates information in an existing table. The update method replaces + the entire table resource, whereas the patch method only replaces fields that + are provided in the submitted table resource. + operationId: bigquery.tables.update + parameters: + - description: Project ID of the table to update + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the table to update + in: path + name: datasetId + required: true + schema: + type: string + - description: Table ID of the table to update + in: path + name: tableId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tables + /projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data: + get: + description: Retrieves table data from a specified set of rows. Requires the + READER dataset role. + operationId: bigquery.tabledata.list + parameters: + - description: Project ID of the table to read + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the table to read + in: path + name: datasetId + required: true + schema: + type: string + - description: Table ID of the table to read + in: path + name: tableId + required: true + schema: + type: string + - description: Maximum number of results to return + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call, identifying the result + set + in: query + name: pageToken + schema: + type: string + - description: List of fields to return (comma-separated). If unspecified, all + fields are returned + in: query + name: selectedFields + schema: + type: string + - description: Zero-based index of the starting row to read + in: query + name: startIndex + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TableDataList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tabledata + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Streams data into BigQuery one record at a time without needing + to run a load job. Requires the WRITER dataset role. + operationId: bigquery.tabledata.insertAll + parameters: + - description: Project ID of the destination table. + in: path + name: projectId + required: true + schema: + type: string + - description: Dataset ID of the destination table. + in: path + name: datasetId + required: true + schema: + type: string + - description: Table ID of the destination table. + in: path + name: tableId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TableDataInsertAllRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TableDataInsertAllResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/bigquery.insertdata + Oauth2c: + - https://www.googleapis.com/auth/bigquery.insertdata + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tabledata + /projects/{projectId}/datasets/{datasetId}/tables/{tableId}/rowAccessPolicies: + get: + description: Lists all row access policies on the specified table. + operationId: bigquery.rowAccessPolicies.list + parameters: + - description: Required. Project ID of the row access policies to list. + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Dataset ID of row access policies to list. + in: path + name: datasetId + required: true + schema: + type: string + - description: Required. Table ID of the table to list row access policies. + in: path + name: tableId + required: true + schema: + type: string + - description: The maximum number of results to return in a single response + page. Leverage the page tokens to iterate through the entire collection. + in: query + name: pageSize + schema: + type: integer + - description: Page token, returned by a previous call, to request the next + page of results. + in: query + name: pageToken + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListRowAccessPoliciesResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - rowAccessPolicies + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectId}/jobs: + get: + description: Lists all jobs that you started in the specified project. Job information + is available for a six month period after creation. The job list is sorted + in reverse chronological order, by job creation time. Requires the Can View + project role, or the Is Owner project role if you set the allUsers property. + operationId: bigquery.jobs.list + parameters: + - description: Project ID of the jobs to list + in: path + name: projectId + required: true + schema: + type: string + - description: Whether to display jobs owned by all users in the project. Default + false + in: query + name: allUsers + schema: + type: boolean + - description: Max value for job creation time, in milliseconds since the POSIX + epoch. If set, only jobs created before or at this timestamp are returned + in: query + name: maxCreationTime + schema: + type: string + - description: Maximum number of results to return + in: query + name: maxResults + schema: + type: integer + - description: Min value for job creation time, in milliseconds since the POSIX + epoch. If set, only jobs created after or at this timestamp are returned + in: query + name: minCreationTime + schema: + type: string + - description: Page token, returned by a previous call, to request the next + page of results + in: query + name: pageToken + schema: + type: string + - description: If set, retrieves only jobs whose parent is this job. Otherwise, + retrieves only jobs which have no parent + in: query + name: parentJobId + schema: + type: string + - description: Restrict information returned to a set of selected fields + in: query + name: projection + schema: + enum: + - full + - minimal + type: string + - description: Filter for job state + explode: true + in: query + name: stateFilter + schema: + items: + enum: + - done + - pending + - running + type: string + type: array + style: form + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JobList' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - jobs + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Starts a new asynchronous job. Requires the Can View project role. + operationId: bigquery.jobs.insert + parameters: + - description: Project ID of the project that will be billed for the job + in: path + name: projectId + required: true + schema: + type: string + requestBody: + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/Job' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - jobs + /projects/{projectId}/jobs/{jobId}: + get: + description: Returns information about a specific job. Job information is available + for a six month period after creation. Requires that you're the person who + ran the job, or have the Is Owner project role. + operationId: bigquery.jobs.get + parameters: + - description: '[Required] Project ID of the requested job' + in: path + name: projectId + required: true + schema: + type: string + - description: '[Required] Job ID of the requested job' + in: path + name: jobId + required: true + schema: + type: string + - description: The geographic location of the job. Required except for US and + EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + in: query + name: location + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - jobs + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectId}/jobs/{jobId}/cancel: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Requests that a job be cancelled. This call will return immediately, + and the client will need to poll for the job status to see if the cancel completed + successfully. Cancelled jobs may still incur costs. + operationId: bigquery.jobs.cancel + parameters: + - description: '[Required] Project ID of the job to cancel' + in: path + name: projectId + required: true + schema: + type: string + - description: '[Required] Job ID of the job to cancel' + in: path + name: jobId + required: true + schema: + type: string + - description: The geographic location of the job. Required except for US and + EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + in: query + name: location + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JobCancelResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - jobs + /projects/{projectId}/jobs/{jobId}/delete: + delete: + description: Requests the deletion of the metadata of a job. This call returns + when the job's metadata is deleted. + operationId: bigquery.jobs.delete + parameters: + - description: Required. Project ID of the job for which metadata is to be deleted. + in: path + name: projectId + required: true + schema: + type: string + - description: Required. Job ID of the job for which metadata is to be deleted. + If this is a parent job which has child jobs, the metadata from all child + jobs will be deleted as well. Direct deletion of the metadata of child jobs + is not allowed. + in: path + name: jobId + required: true + schema: + type: string + - description: 'The geographic location of the job. Required. See details at: + https://cloud.google.com/bigquery/docs/locations#specifying_your_location.' + in: query + name: location + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - jobs + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectId}/queries: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Runs a BigQuery SQL query synchronously and returns query results + if the query completes within a specified timeout. + operationId: bigquery.jobs.query + parameters: + - description: Project ID of the project billed for the query + in: path + name: projectId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - jobs + /projects/{projectId}/queries/{jobId}: + get: + description: Retrieves the results of a query job. + operationId: bigquery.jobs.getQueryResults + parameters: + - description: '[Required] Project ID of the query job' + in: path + name: projectId + required: true + schema: + type: string + - description: '[Required] Job ID of the query job' + in: path + name: jobId + required: true + schema: + type: string + - description: The geographic location where the job should run. Required except + for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + in: query + name: location + schema: + type: string + - description: Maximum number of results to read + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call, to request the next + page of results + in: query + name: pageToken + schema: + type: string + - description: Zero-based index of the starting row + in: query + name: startIndex + schema: + type: string + - description: How long to wait for the query to complete, in milliseconds, + before returning. Default is 10 seconds. If the timeout passes before the + job completes, the 'jobComplete' field in the response will be false + in: query + name: timeoutMs + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetQueryResultsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - jobs + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectId}/serviceAccount: + get: + description: Returns the email address of the service account for your project + used for interactions with Google Cloud KMS. + operationId: bigquery.projects.getServiceAccount + parameters: + - description: Project ID for which the service account is requested. + in: path + name: projectId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetServiceAccountResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - projects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectsId}/datasets/{datasetsId}/models: + get: + description: Lists all models in the specified dataset. Requires the READER + dataset role. After retrieving the list of models, you can get information + about a particular model by calling the models.get method. + operationId: bigquery.models.list + parameters: + - description: The maximum number of results to return in a single response + page. Leverage the page tokens to iterate through the entire collection. + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call to request the next page + of results + in: query + name: pageToken + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListModelsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - models + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectsId}/datasets/{datasetsId}/models/{modelsId}: + delete: + description: Deletes the model specified by modelId from the dataset. + operationId: bigquery.models.delete + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - models + get: + description: Gets the specified model resource by model ID. + operationId: bigquery.models.get + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - models + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Patch specific fields in the specified model. + operationId: bigquery.models.patch + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - models + /projects/{projectsId}/datasets/{datasetsId}/routines: + get: + description: Lists all routines in the specified dataset. Requires the READER + dataset role. + operationId: bigquery.routines.list + parameters: + - description: 'If set, then only the Routines matching this filter are returned. + The current supported form is either "routine_type:" or "routineType:", + where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION".' + in: query + name: filter + schema: + type: string + - description: The maximum number of results to return in a single response + page. Leverage the page tokens to iterate through the entire collection. + in: query + name: maxResults + schema: + type: integer + - description: Page token, returned by a previous call, to request the next + page of results + in: query + name: pageToken + schema: + type: string + - description: 'If set, then only the Routine fields in the field mask, as well + as project_id, dataset_id and routine_id, are returned in the response. + If unset, then the following Routine fields are returned: etag, project_id, + dataset_id, routine_id, routine_type, creation_time, last_modified_time, + and language.' + in: query + name: readMask + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListRoutinesResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - routines + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new routine in the dataset. + operationId: bigquery.routines.insert + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - routines + /projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}: + delete: + description: Deletes the routine specified by routineId from the dataset. + operationId: bigquery.routines.delete + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: routinesId + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - routines + get: + description: Gets the specified routine resource by routine ID. + operationId: bigquery.routines.get + parameters: + - description: If set, only the Routine fields in the field mask are returned + in the response. If unset, all Routine fields are returned. + in: query + name: readMask + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: routinesId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - routines + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + put: + description: Updates information in an existing routine. The update method replaces + the entire Routine resource. + operationId: bigquery.routines.update + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: routinesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Routine' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - routines + /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies: + get: + description: Lists all row access policies on the specified table. + operationId: bigquery.rowAccessPolicies.list + parameters: + - description: The maximum number of results to return in a single response + page. Leverage the page tokens to iterate through the entire collection. + in: query + name: pageSize + schema: + type: integer + - description: Page token, returned by a previous call, to request the next + page of results. + in: query + name: pageToken + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListRowAccessPoliciesResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - rowAccessPolicies + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Gets the access control policy for a resource. Returns an empty + policy if the resource exists and does not have a policy set. + operationId: bigquery.tables.getIamPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + - in: path + name: rowAccessPoliciesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tables + /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` + errors. + operationId: bigquery.tables.setIamPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + - in: path + name: rowAccessPoliciesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tables + /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: 'Returns permissions that a caller has on the specified resource. + If the resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for building + permission-aware UIs and command-line tools, not for authorization checking. + This operation may "fail open" without warning.' + operationId: bigquery.tables.testIamPermissions + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + - in: path + name: rowAccessPoliciesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tables + /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Gets the access control policy for a resource. Returns an empty + policy if the resource exists and does not have a policy set. + operationId: bigquery.tables.getIamPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tables + /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` + errors. + operationId: bigquery.tables.setIamPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tables + /projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: 'Returns permissions that a caller has on the specified resource. + If the resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for building + permission-aware UIs and command-line tools, not for authorization checking. + This operation may "fail open" without warning.' + operationId: bigquery.tables.testIamPermissions + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tables + /projects/{projectsId}/jobs/{jobsId}/delete: + delete: + description: Requests the deletion of the metadata of a job. This call returns + when the job's metadata is deleted. + operationId: bigquery.jobs.delete + parameters: + - description: 'The geographic location of the job. Required. See details at: + https://cloud.google.com/bigquery/docs/locations#specifying_your_location.' + in: query + name: location + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - jobs + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /{resource}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Gets the access control policy for a resource. Returns an empty + policy if the resource exists and does not have a policy set. + operationId: bigquery.tables.getIamPolicy + parameters: + - description: 'REQUIRED: The resource for which the policy is being requested. + See the operation documentation for the appropriate value for this field.' + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tables + /{resource}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Sets the access control policy on the specified resource. Replaces + any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` + errors. + operationId: bigquery.tables.setIamPolicy + parameters: + - description: 'REQUIRED: The resource for which the policy is being specified. + See the operation documentation for the appropriate value for this field.' + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tables + /{resource}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: 'Returns permissions that a caller has on the specified resource. + If the resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for building + permission-aware UIs and command-line tools, not for authorization checking. + This operation may "fail open" without warning.' + operationId: bigquery.tables.testIamPermissions + parameters: + - description: 'REQUIRED: The resource for which the policy detail is being + requested. See the operation documentation for the appropriate value for + this field.' + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tables +servers: +- url: https://bigquery.googleapis.com/bigquery/v2 +tags: +- name: datasets +- name: jobs +- name: models +- name: projects +- name: routines +- name: rowAccessPolicies +- name: tabledata +- name: tables diff --git a/test/registry/src/googleapis.com/v1/services/bigquery-v2.yaml.sig b/test/registry/src/googleapis.com/v1/services/bigquery-v2.yaml.sig new file mode 100644 index 00000000..f88c93b4 --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services/bigquery-v2.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELlL86SOAKUAX2BrcJ2PDn4zyoG5fD7hh7NV+JkHL/ErfiZxorrRyFeeeY6bPF/qKkqpNYPBJQt6a3IhzLvk+8ajm6jPJVSDw== \ No newline at end of file diff --git a/test/registry/src/googleapis.com/v1/services/cloudresourcemanager-v3.yaml b/test/registry/src/googleapis.com/v1/services/cloudresourcemanager-v3.yaml new file mode 100644 index 00000000..d50fb104 --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services/cloudresourcemanager-v3.yaml @@ -0,0 +1,4674 @@ +components: + parameters: + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + enum: + - '1' + - '2' + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + enum: + - json + - media + - proto + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: API key. Your API key identifies your project and provides you + with API access, quota, and reports. Required unless you provide an OAuth + 2.0 token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: Available to use for quota purposes for server-side applications. + Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + in: query + name: quotaUser + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + schemas: + AuditConfig: + description: 'Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if any, + are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. + If there are AuditConfigs for both `allServices` and a specific service, the + union of the two AuditConfigs is used for that service: the log_types specified + in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig + are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": + [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" + }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", + "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", + "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, + this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also + exempts jose@example.com from DATA_READ logging, and aliya@example.com from + DATA_WRITE logging.' + properties: + auditLogConfigs: + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/AuditLogConfig' + type: array + service: + description: Specifies a service that will be enabled for audit logging. + For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` + is a special value that covers all services. + type: string + type: object + AuditLogConfig: + description: 'Provides the configuration for logging a type of permissions. + Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": + [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables + ''DATA_READ'' and ''DATA_WRITE'' logging, while exempting jose@example.com + from DATA_READ logging.' + properties: + exemptedMembers: + description: Specifies the identities that do not cause logging for this + type of permission. Follows the same format of Binding.members. + items: + type: string + type: array + logType: + description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + type: string + type: object + Binding: + description: Associates `members`, or principals, with a `role`. + properties: + condition: + $ref: '#/components/schemas/Expr' + description: The condition that is associated with this binding. If the + condition evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding does + not apply to the current request. However, a different role binding might + grant the same role to one or more of the principals in this binding. + To learn which resources support conditions in their IAM policies, see + the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + members: + description: 'Specifies the principals requesting access for a Cloud Platform + resource. `members` can have the following values: * `allUsers`: A special + identifier that represents anyone who is on the internet; with or without + a Google account. * `allAuthenticatedUsers`: A special identifier that + represents anyone who is authenticated with a Google account or a service + account. * `user:{emailid}`: An email address that represents a specific + Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: + An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. + * `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a user that has + been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and the + recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a service account + that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` + and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google group + that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. + If the group is recovered, this value reverts to `group:{emailid}` and + the recovered group retains the role in the binding. * `domain:{domain}`: + The G Suite domain (primary) that represents all the users of that domain. + For example, `google.com` or `example.com`. ' + items: + type: string + type: array + role: + description: Role that is assigned to the list of `members`, or principals. + For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + type: string + type: object + CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation: + description: Metadata describing a long running folder operation + properties: + destinationParent: + description: The resource name of the folder or organization we are either + creating the folder under or moving the folder to. + type: string + displayName: + description: The display name of the folder. + type: string + operationType: + description: The type of this operation. + enum: + - OPERATION_TYPE_UNSPECIFIED + - CREATE + - MOVE + type: string + sourceParent: + description: The resource name of the folder's parent. Only applicable when + the operation_type is MOVE. + type: string + type: object + CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation: + description: Metadata describing a long running folder operation + properties: + destinationParent: + description: The resource name of the folder or organization we are either + creating the folder under or moving the folder to. + type: string + displayName: + description: The display name of the folder. + type: string + operationType: + description: The type of this operation. + enum: + - OPERATION_TYPE_UNSPECIFIED + - CREATE + - MOVE + type: string + sourceParent: + description: The resource name of the folder's parent. Only applicable when + the operation_type is MOVE. + type: string + type: object + CreateFolderMetadata: + description: Metadata pertaining to the Folder creation process. + properties: + displayName: + description: The display name of the folder. + type: string + parent: + description: The resource name of the folder or organization we are creating + the folder under. + type: string + type: object + CreateProjectMetadata: + description: A status object which is used as the `metadata` field for the Operation + returned by CreateProject. It provides insight for when significant phases + of Project creation have completed. + properties: + createTime: + description: Creation time of the project creation workflow. + format: google-datetime + type: string + gettable: + description: True if the project can be retrieved using `GetProject`. No + other operations on the project are guaranteed to work until the project + creation is complete. + type: boolean + ready: + description: True if the project creation process is complete. + type: boolean + type: object + CreateTagBindingMetadata: + description: Runtime operation information for creating a TagValue. + properties: {} + type: object + CreateTagKeyMetadata: + description: Runtime operation information for creating a TagKey. + properties: {} + type: object + CreateTagValueMetadata: + description: Runtime operation information for creating a TagValue. + properties: {} + type: object + DeleteFolderMetadata: + description: A status object which is used as the `metadata` field for the `Operation` + returned by `DeleteFolder`. + properties: {} + type: object + DeleteOrganizationMetadata: + description: LINT.IfChange A status object which is used as the `metadata` field + for the operation returned by DeleteOrganization. + properties: {} + type: object + DeleteProjectMetadata: + description: A status object which is used as the `metadata` field for the Operation + returned by `DeleteProject`. + properties: {} + type: object + DeleteTagBindingMetadata: + description: Runtime operation information for deleting a TagBinding. + properties: {} + type: object + DeleteTagKeyMetadata: + description: Runtime operation information for deleting a TagKey. + properties: {} + type: object + DeleteTagValueMetadata: + description: Runtime operation information for deleting a TagValue. + properties: {} + type: object + Empty: + description: 'A generic empty message that you can re-use to avoid defining + duplicated empty messages in your APIs. A typical example is to use it as + the request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON + representation for `Empty` is empty JSON object `{}`.' + properties: {} + 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.' + 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 + Folder: + description: A folder in an organization's resource hierarchy, used to organize + that organization's resources. + properties: + createTime: + description: Output only. Timestamp when the folder was created. + format: google-datetime + readOnly: true + type: string + deleteTime: + description: Output only. Timestamp when the folder was requested to be + deleted. + format: google-datetime + readOnly: true + type: string + displayName: + description: 'The folder''s display name. A folder''s display name must + be unique amongst its siblings. For example, no two folders with the same + parent can share the same display name. The display name must start and + end with a letter or digit, may contain letters, digits, spaces, hyphens + and underscores and can be no longer than 30 characters. This is captured + by the regular expression: `[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`.' + type: string + etag: + description: Output only. A checksum computed by the server based on the + current value of the folder resource. This may be sent on update and delete + requests to ensure the client has an up-to-date value before proceeding. + readOnly: true + type: string + name: + description: 'Output only. The resource name of the folder. Its format is + `folders/{folder_id}`, for example: "folders/1234".' + readOnly: true + type: string + parent: + description: Required. The folder's parent's resource name. Updates to the + folder's parent must be performed using MoveFolder. + type: string + state: + description: Output only. The lifecycle state of the folder. Updates to + the state must be performed using DeleteFolder and UndeleteFolder. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETE_REQUESTED + readOnly: true + type: string + updateTime: + description: Output only. Timestamp when the folder was last modified. + format: google-datetime + readOnly: true + type: string + type: object + FolderOperation: + description: Metadata describing a long running folder operation + properties: + destinationParent: + description: The resource name of the folder or organization we are either + creating the folder under or moving the folder to. + type: string + displayName: + description: The display name of the folder. + type: string + operationType: + description: The type of this operation. + enum: + - OPERATION_TYPE_UNSPECIFIED + - CREATE + - MOVE + type: string + sourceParent: + description: The resource name of the folder's parent. Only applicable when + the operation_type is MOVE. + type: string + type: object + FolderOperationError: + description: A classification of the Folder Operation error. + properties: + errorMessageId: + description: The type of operation error experienced. + enum: + - ERROR_TYPE_UNSPECIFIED + - ACTIVE_FOLDER_HEIGHT_VIOLATION + - MAX_CHILD_FOLDERS_VIOLATION + - FOLDER_NAME_UNIQUENESS_VIOLATION + - RESOURCE_DELETED_VIOLATION + - PARENT_DELETED_VIOLATION + - CYCLE_INTRODUCED_VIOLATION + - FOLDER_BEING_MOVED_VIOLATION + - FOLDER_TO_DELETE_NON_EMPTY_VIOLATION + - DELETED_FOLDER_HEIGHT_VIOLATION + type: string + type: object + GetIamPolicyRequest: + description: Request message for `GetIamPolicy` method. + properties: + options: + $ref: '#/components/schemas/GetPolicyOptions' + description: 'OPTIONAL: A `GetPolicyOptions` object for specifying options + to `GetIamPolicy`.' + type: object + GetPolicyOptions: + description: Encapsulates settings provided to GetIamPolicy. + properties: + requestedPolicyVersion: + description: Optional. The policy format version to be returned. Valid values + are 0, 1, and 3. Requests specifying an invalid value will be rejected. + Requests for policies with any conditional bindings must specify version + 3. Policies without any conditional bindings may specify any valid value + or leave the field unset. To learn which resources support conditions + in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + format: int32 + type: integer + type: object + Lien: + description: A Lien represents an encumbrance on the actions that can be performed + on a resource. + properties: + createTime: + description: The creation time of this Lien. + format: google-datetime + type: string + name: + description: 'A system-generated unique identifier for this Lien. Example: + `liens/1234abcd`' + type: string + origin: + description: 'A stable, user-visible/meaningful string identifying the origin + of the Lien, intended to be inspected programmatically. Maximum length + of 200 characters. Example: ''compute.googleapis.com''' + type: string + parent: + description: 'A reference to the resource this Lien is attached to. The + server will validate the parent against those for which Liens are supported. + Example: `projects/1234`' + type: string + reason: + description: 'Concise user-visible strings indicating why an action cannot + be performed on a resource. Maximum length of 200 characters. Example: + ''Holds production API key''' + type: string + restrictions: + description: 'The types of operations which should be blocked as a result + of this Lien. Each value should correspond to an IAM permission. The server + will validate the permissions against those for which Liens are supported. + An empty list is meaningless and will be rejected. Example: [''resourcemanager.projects.delete'']' + items: + type: string + type: array + type: object + ListFoldersResponse: + description: The ListFolders response message. + properties: + folders: + description: A possibly paginated list of folders that are direct descendants + of the specified parent resource. + items: + $ref: '#/components/schemas/Folder' + type: array + nextPageToken: + description: A pagination token returned from a previous call to `ListFolders` + that indicates from where listing should continue. + type: string + type: object + ListLiensResponse: + description: The response message for Liens.ListLiens. + properties: + liens: + description: A list of Liens. + items: + $ref: '#/components/schemas/Lien' + type: array + nextPageToken: + description: Token to retrieve the next page of results, or empty if there + are no more results in the list. + type: string + type: object + ListProjectsResponse: + description: 'A page of the response received from the ListProjects method. + A paginated response where more pages are available has `next_page_token` + set. This token can be used in a subsequent request to retrieve the next request + page. NOTE: A response may contain fewer elements than the request `page_size` + and still have a `next_page_token`.' + properties: + nextPageToken: + description: Pagination token. If the result set is too large to fit in + a single response, this token is returned. It encodes the position of + the current result cursor. Feeding this value into a new list request + with the `page_token` parameter gives the next page of the results. When + `next_page_token` is not filled in, there is no next page and the list + returned is the last page in the result set. Pagination tokens have a + limited lifetime. + type: string + projects: + description: The list of Projects under the parent. This list can be paginated. + items: + $ref: '#/components/schemas/Project' + type: array + type: object + ListTagBindingsResponse: + description: The ListTagBindings response. + properties: + nextPageToken: + description: Pagination token. If the result set is too large to fit in + a single response, this token is returned. It encodes the position of + the current result cursor. Feeding this value into a new list request + with the `page_token` parameter gives the next page of the results. When + `next_page_token` is not filled in, there is no next page and the list + returned is the last page in the result set. Pagination tokens have a + limited lifetime. + type: string + tagBindings: + description: A possibly paginated list of TagBindings for the specified + resource. + items: + $ref: '#/components/schemas/TagBinding' + type: array + type: object + ListTagKeysResponse: + description: The ListTagKeys response message. + properties: + nextPageToken: + description: A pagination token returned from a previous call to `ListTagKeys` + that indicates from where listing should continue. + type: string + tagKeys: + description: List of TagKeys that live under the specified parent in the + request. + items: + $ref: '#/components/schemas/TagKey' + type: array + type: object + ListTagValuesResponse: + description: The ListTagValues response. + properties: + nextPageToken: + description: A pagination token returned from a previous call to `ListTagValues` + that indicates from where listing should continue. This is currently not + used, but the server may at any point start supplying a valid token. + type: string + tagValues: + description: A possibly paginated list of TagValues that are direct descendants + of the specified parent TagKey. + items: + $ref: '#/components/schemas/TagValue' + type: array + type: object + MoveFolderMetadata: + description: Metadata pertaining to the folder move process. + properties: + destinationParent: + description: The resource name of the folder or organization to move the + folder to. + type: string + displayName: + description: The display name of the folder. + type: string + sourceParent: + description: The resource name of the folder's parent. + type: string + type: object + MoveFolderRequest: + description: The MoveFolder request message. + properties: + destinationParent: + description: Required. The resource name of the folder or organization which + should be the folder's new parent. Must be of the form `folders/{folder_id}` + or `organizations/{org_id}`. + type: string + type: object + MoveProjectMetadata: + description: A status object which is used as the `metadata` field for the Operation + returned by MoveProject. + properties: {} + type: object + MoveProjectRequest: + description: The request sent to MoveProject method. + properties: + destinationParent: + description: Required. The new parent to move the Project under. + type: string + type: object + Operation: + description: This resource represents a long-running operation that is the result + of a network API call. + properties: + done: + description: 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. + type: boolean + error: + $ref: '#/components/schemas/Status' + description: The error result of the operation in case of failure or cancellation. + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type + URL. + description: 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. + type: object + name: + description: 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}`. + type: string + response: + additionalProperties: + description: Properties of the object. Contains field @type with type + URL. + description: 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`. + type: object + type: object + Organization: + description: The root node in the resource hierarchy to which a particular entity's + (a company, for example) resources belong. + properties: + createTime: + description: Output only. Timestamp when the Organization was created. + format: google-datetime + readOnly: true + type: string + deleteTime: + description: Output only. Timestamp when the Organization was requested + for deletion. + format: google-datetime + readOnly: true + type: string + directoryCustomerId: + description: Immutable. The G Suite / Workspace customer id used in the + Directory API. + type: string + displayName: + description: Output only. A human-readable string that refers to the organization + in the Google Cloud Console. This string is set by the server and cannot + be changed. The string will be set to the primary domain (for example, + "google.com") of the Google Workspace customer that owns the organization. + readOnly: true + type: string + etag: + description: Output only. A checksum computed by the server based on the + current value of the Organization resource. This may be sent on update + and delete requests to ensure the client has an up-to-date value before + proceeding. + readOnly: true + type: string + name: + description: Output only. The resource name of the organization. This is + the organization's relative path in the API. Its format is "organizations/[organization_id]". + For example, "organizations/1234". + readOnly: true + type: string + state: + description: Output only. The organization's current lifecycle state. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETE_REQUESTED + readOnly: true + type: string + updateTime: + description: Output only. Timestamp when the Organization was last modified. + format: google-datetime + 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/).' + properties: + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + items: + $ref: '#/components/schemas/AuditConfig' + type: array + bindings: + description: Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when the + `bindings` are applied. Each of the `bindings` must contain at least one + principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; + up to 250 of these principals can be Google groups. Each occurrence of + a principal counts towards these limits. For example, if the `bindings` + grant 50 different roles to `user:alice@example.com`, and not to any other + principal, then you can add another 1,450 principals to the `bindings` + in the `Policy`. + items: + $ref: '#/components/schemas/Binding' + type: array + etag: + description: '`etag` is used for optimistic concurrency control as a way + to help prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` in + the read-modify-write cycle to perform policy updates in order to avoid + race conditions: An `etag` is returned in the response to `getIamPolicy`, + and systems are expected to put that etag in the request to `setIamPolicy` + to ensure that their change will be applied to the same version of the + policy. **Important:** If you use IAM Conditions, you must include the + `etag` field whenever you call `setIamPolicy`. If you omit this field, + then IAM allows you to overwrite a version `3` policy with a version `1` + policy, and all of the conditions in the version `3` policy are lost.' + format: byte + type: string + version: + description: 'Specifies the format of the policy. Valid values are `0`, + `1`, and `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify version + `3`. This requirement applies to the following operations: * Getting a + policy that includes a conditional role binding * Adding a conditional + role binding to a policy * Changing a conditional role binding in a policy + * Removing any role binding, with or without a condition, from a policy + that includes conditions **Important:** If you use IAM Conditions, you + must include the `etag` field whenever you call `setIamPolicy`. If you + omit this field, then IAM allows you to overwrite a version `3` policy + with a version `1` policy, and all of the conditions in the version `3` + policy are lost. If a policy does not include any conditions, operations + on that policy may specify any valid version or leave the field unset. + To learn which resources support conditions in their IAM policies, see + the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).' + format: int32 + type: integer + type: object + Project: + description: A project is a high-level Google Cloud entity. It is a container + for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + properties: + createTime: + description: Output only. Creation time. + format: google-datetime + readOnly: true + type: string + deleteTime: + description: Output only. The time at which this resource was requested + for deletion. + format: google-datetime + readOnly: true + type: string + displayName: + description: 'Optional. A user-assigned display name of the project. When + present it must be between 4 to 30 characters. Allowed characters are: + lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, + space, and exclamation point. Example: `My Project`' + type: string + etag: + description: Output only. A checksum computed by the server based on the + current value of the Project resource. This may be sent on update and + delete requests to ensure the client has an up-to-date value before proceeding. + readOnly: true + type: string + labels: + additionalProperties: + type: string + description: 'Optional. The labels associated with this project. Label keys + must be between 1 and 63 characters long and must conform to the following + regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must + be between 0 and 63 characters long and must conform to the regular expression + (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated + with a given resource. Clients should store labels in a representation + such as JSON that does not depend on specific characters being disallowed. + Example: `"myBusinessDimension" : "businessValue"`' + type: object + name: + description: 'Output only. The unique resource name of the project. It is + an int64 generated number prefixed by "projects/". Example: `projects/415104041262`' + readOnly: true + type: string + parent: + description: Optional. A reference to a parent Resource. eg., `organizations/123` + or `folders/876`. + type: string + projectId: + description: 'Immutable. The unique, user-assigned id of the project. It + must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start + with a letter. Trailing hyphens are prohibited. Example: `tokyo-rain-123`' + type: string + state: + description: Output only. The project lifecycle state. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETE_REQUESTED + readOnly: true + type: string + updateTime: + description: Output only. The most recent time this resource was modified. + format: google-datetime + readOnly: true + type: string + type: object + ProjectCreationStatus: + description: A status object which is used as the `metadata` field for the Operation + returned by CreateProject. It provides insight for when significant phases + of Project creation have completed. + properties: + createTime: + description: Creation time of the project creation workflow. + format: google-datetime + type: string + gettable: + description: True if the project can be retrieved using GetProject. No other + operations on the project are guaranteed to work until the project creation + is complete. + type: boolean + ready: + description: True if the project creation process is complete. + type: boolean + type: object + SearchFoldersResponse: + description: The response message for searching folders. + properties: + folders: + description: A possibly paginated folder search results. the specified parent + resource. + items: + $ref: '#/components/schemas/Folder' + type: array + nextPageToken: + description: A pagination token returned from a previous call to `SearchFolders` + that indicates from where searching should continue. + type: string + type: object + SearchOrganizationsResponse: + description: The response returned from the `SearchOrganizations` method. + properties: + nextPageToken: + description: A pagination token to be used to retrieve the next page of + results. If the result is too large to fit within the page size specified + in the request, this field will be set with a token that can be used to + fetch the next page of results. If this field is empty, it indicates that + this response contains the last page of results. + type: string + organizations: + description: The list of Organizations that matched the search query, possibly + paginated. + items: + $ref: '#/components/schemas/Organization' + type: array + type: object + SearchProjectsResponse: + description: A page of the response received from the SearchProjects method. + A paginated response where more pages are available has `next_page_token` + set. This token can be used in a subsequent request to retrieve the next request + page. + properties: + nextPageToken: + description: Pagination token. If the result set is too large to fit in + a single response, this token is returned. It encodes the position of + the current result cursor. Feeding this value into a new list request + with the `page_token` parameter gives the next page of the results. When + `next_page_token` is not filled in, there is no next page and the list + returned is the last page in the result set. Pagination tokens have a + limited lifetime. + type: string + projects: + description: The list of Projects that matched the list filter query. This + list can be paginated. + items: + $ref: '#/components/schemas/Project' + type: array + type: object + SetIamPolicyRequest: + description: Request message for `SetIamPolicy` method. + properties: + policy: + $ref: '#/components/schemas/Policy' + description: 'REQUIRED: The complete policy to be applied to the `resource`. + The size of the policy is limited to a few 10s of KB. An empty policy + is a valid policy but certain Cloud Platform services (such as Projects) + might reject them.' + updateMask: + description: 'OPTIONAL: A FieldMask specifying which fields of the policy + to modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, etag"`' + format: google-fieldmask + type: string + type: object + Status: + description: '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).' + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + details: + description: A list of messages that carry the error details. There is a + common set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type + URL. + type: object + type: array + message: + description: 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. + type: string + type: object + TagBinding: + description: A TagBinding represents a connection between a TagValue and a cloud + resource (currently project, folder, or organization). Once a TagBinding is + created, the TagValue is applied to all the descendants of the cloud resource. + properties: + name: + description: 'Output only. The name of the TagBinding. This is a String + of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. + `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).' + readOnly: true + type: string + parent: + description: The full resource name of the resource the TagValue is bound + to. E.g. `//cloudresourcemanager.googleapis.com/projects/123` + type: string + tagValue: + description: The TagValue of the TagBinding. Must be of the form `tagValues/456`. + type: string + type: object + TagKey: + description: A TagKey, used to group a set of TagValues. + properties: + createTime: + description: Output only. Creation time. + format: google-datetime + readOnly: true + type: string + description: + description: Optional. User-assigned description of the TagKey. Must not + exceed 256 characters. Read-write. + type: string + etag: + description: Optional. Entity tag which users can pass to prevent race conditions. + This field is always set in server responses. See UpdateTagKeyRequest + for details. + type: string + name: + description: Immutable. The resource name for a TagKey. Must be in the format + `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id + for the TagKey. + type: string + namespacedName: + description: Output only. Immutable. Namespaced name of the TagKey. + readOnly: true + type: string + parent: + description: Immutable. The resource name of the new TagKey's parent. Must + be of the form `organizations/{org_id}`. + type: string + shortName: + description: Required. Immutable. The user friendly name for a TagKey. The + short name should be unique for TagKeys within the same tag namespace. + The short name must be 1-63 characters, beginning and ending with an alphanumeric + character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and + alphanumerics between. + type: string + updateTime: + description: Output only. Update time. + format: google-datetime + readOnly: true + type: string + type: object + TagValue: + description: A TagValue is a child of a particular TagKey. This is used to group + cloud resources for the purpose of controlling them using policies. + properties: + createTime: + description: Output only. Creation time. + format: google-datetime + readOnly: true + type: string + description: + description: Optional. User-assigned description of the TagValue. Must not + exceed 256 characters. Read-write. + type: string + etag: + description: Optional. Entity tag which users can pass to prevent race conditions. + This field is always set in server responses. See UpdateTagValueRequest + for details. + type: string + name: + description: Immutable. Resource name for TagValue in the format `tagValues/456`. + type: string + namespacedName: + description: Output only. Namespaced name of the TagValue. Must be in the + format `{organization_id}/{tag_key_short_name}/{short_name}`. + readOnly: true + type: string + parent: + description: Immutable. The resource name of the new TagValue's parent TagKey. + Must be of the form `tagKeys/{tag_key_id}`. + type: string + shortName: + description: Required. Immutable. User-assigned short name for TagValue. + The short name should be unique for TagValues within the same parent TagKey. + The short name must be 63 characters or less, beginning and ending with + an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), + dots (.), and alphanumerics between. + type: string + updateTime: + description: Output only. Update time. + format: google-datetime + readOnly: true + type: string + type: object + TestIamPermissionsRequest: + description: Request message for `TestIamPermissions` method. + properties: + permissions: + description: The set of permissions to check for the `resource`. Permissions + with wildcards (such as '*' or 'storage.*') are not allowed. For more + information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + items: + type: string + type: array + type: object + TestIamPermissionsResponse: + description: Response message for `TestIamPermissions` method. + properties: + permissions: + description: A subset of `TestPermissionsRequest.permissions` that the caller + is allowed. + items: + type: string + type: array + type: object + UndeleteFolderMetadata: + description: A status object which is used as the `metadata` field for the `Operation` + returned by `UndeleteFolder`. + properties: {} + type: object + UndeleteFolderRequest: + description: The UndeleteFolder request message. + properties: {} + type: object + UndeleteOrganizationMetadata: + description: LINT.IfChange A status object which is used as the `metadata` field + for the Operation returned by UndeleteOrganization. + properties: {} + type: object + UndeleteProjectMetadata: + description: A status object which is used as the `metadata` field for the Operation + returned by `UndeleteProject`. + properties: {} + type: object + UndeleteProjectRequest: + description: The request sent to the UndeleteProject method. + properties: {} + type: object + UpdateFolderMetadata: + description: A status object which is used as the `metadata` field for the Operation + returned by UpdateFolder. + properties: {} + type: object + UpdateProjectMetadata: + description: A status object which is used as the `metadata` field for the Operation + returned by UpdateProject. + properties: {} + type: object + UpdateTagKeyMetadata: + description: Runtime operation information for updating a TagKey. + properties: {} + type: object + UpdateTagValueMetadata: + description: Runtime operation information for updating a TagValue. + properties: {} + type: object + securitySchemes: + Oauth2: + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + https://www.googleapis.com/auth/cloud-platform.read-only: View your data + across Google Cloud services and see the email address of your Google + Account + type: oauth2 + Oauth2c: + description: Oauth 2.0 authorizationCode authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + https://www.googleapis.com/auth/cloud-platform.read-only: View your data + across Google Cloud services and see the email address of your Google + Account + tokenUrl: https://accounts.google.com/o/oauth2/token + type: oauth2 + x-stackQL-resources: + folders: + id: google.cloudresourcemanager.folders + methods: + create: + operation: + $ref: post + path: + $ref: /v3/folders + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v3/folders/{foldersId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v3/folders/{foldersId} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: post + path: + $ref: /v3/folders/{foldersId}:getIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v3/folders + response: + mediaType: application/json + openAPIDocKey: '200' + move: + operation: + $ref: post + path: + $ref: /v3/folders/{foldersId}:move + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /v3/folders/{foldersId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + search: + operation: + $ref: get + path: + $ref: /v3/folders:search + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /v3/folders/{foldersId}:setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /v3/folders/{foldersId}:testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: post + path: + $ref: /v3/folders/{foldersId}:undelete + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: folders + title: folders + liens: + id: google.cloudresourcemanager.liens + methods: + create: + operation: + $ref: post + path: + $ref: /v3/liens + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v3/liens/{liensId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v3/liens/{liensId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v3/liens + response: + mediaType: application/json + openAPIDocKey: '200' + name: liens + title: liens + operations: + id: google.cloudresourcemanager.operations + methods: + get: + operation: + $ref: get + path: + $ref: /v3/operations/{operationsId} + response: + mediaType: application/json + openAPIDocKey: '200' + name: operations + title: operations + organizations: + id: google.cloudresourcemanager.organizations + methods: + get: + operation: + $ref: get + path: + $ref: /v3/organizations/{organizationsId} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: post + path: + $ref: /v3/organizations/{organizationsId}:getIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + search: + operation: + $ref: get + path: + $ref: /v3/organizations:search + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /v3/organizations/{organizationsId}:setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /v3/organizations/{organizationsId}:testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: organizations + title: organizations + projects: + id: google.cloudresourcemanager.projects + methods: + create: + operation: + $ref: post + path: + $ref: /v3/projects + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v3/projects/{projectsId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v3/projects/{projectsId} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: post + path: + $ref: /v3/projects/{projectsId}:getIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v3/projects + response: + mediaType: application/json + openAPIDocKey: '200' + move: + operation: + $ref: post + path: + $ref: /v3/projects/{projectsId}:move + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /v3/projects/{projectsId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + search: + operation: + $ref: get + path: + $ref: /v3/projects:search + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /v3/projects/{projectsId}:setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /v3/projects/{projectsId}:testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: post + path: + $ref: /v3/projects/{projectsId}:undelete + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects + title: projects + tagBindings: + id: google.cloudresourcemanager.tagBindings + methods: + create: + operation: + $ref: post + path: + $ref: /v3/tagBindings + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v3/tagBindings/{tagBindingsId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v3/tagBindings + response: + mediaType: application/json + openAPIDocKey: '200' + name: tagBindings + title: tagBindings + tagKeys: + id: google.cloudresourcemanager.tagKeys + methods: + create: + operation: + $ref: post + path: + $ref: /v3/tagKeys + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v3/tagKeys/{tagKeysId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v3/tagKeys/{tagKeysId} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: post + path: + $ref: /v3/tagKeys/{tagKeysId}:getIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v3/tagKeys + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /v3/tagKeys/{tagKeysId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /v3/tagKeys/{tagKeysId}:setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /v3/tagKeys/{tagKeysId}:testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: tagKeys + title: tagKeys + tagValues: + id: google.cloudresourcemanager.tagValues + methods: + create: + operation: + $ref: post + path: + $ref: /v3/tagValues + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v3/tagValues/{tagValuesId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v3/tagValues/{tagValuesId} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: post + path: + $ref: /v3/tagValues/{tagValuesId}:getIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v3/tagValues + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /v3/tagValues/{tagValuesId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: post + path: + $ref: /v3/tagValues/{tagValuesId}:setIamPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: post + path: + $ref: /v3/tagValues/{tagValuesId}:testIamPermissions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: tagValues + title: tagValues +externalDocs: + url: https://cloud.google.com/resource-manager +info: + contact: + name: Google + url: https://google.com + x-twitter: youtube + description: Creates, reads, and updates metadata for Google Cloud Platform resource + containers. + license: + name: Creative Commons Attribution 3.0 + url: http://creativecommons.org/licenses/by/3.0/ + termsOfService: https://developers.google.com/terms/ + title: Cloud Resource Manager API + version: v3 + x-apisguru-categories: + - analytics + - media + x-logo: + url: https://api.apis.guru/v2/cache/logo/https_upload.wikimedia.org_wikipedia_commons_e_e1_YouTube_play_buttom_icon_%282013-2017%29.svg + x-origin: + - format: google + url: https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v3 + version: v1 + x-providerName: googleapis.com + x-serviceName: cloudresourcemanager +openapi: 3.0.0 +paths: + /v3/folders: + get: + description: Lists the folders that are direct descendants of supplied parent + resource. `list()` provides a strongly consistent view of the folders underneath + the specified parent resource. `list()` returns folders sorted based upon + the (ascending) lexical ordering of their display_name. The caller must have + `resourcemanager.folders.list` permission on the identified parent. + operationId: cloudresourcemanager.folders.list + parameters: + - description: Optional. The maximum number of folders to return in the response. + The server can return fewer folders than requested. If unspecified, server + picks an appropriate default. + in: query + name: pageSize + schema: + type: integer + - description: Optional. A pagination token returned from a previous call to + `ListFolders` that indicates where this listing should continue from. + in: query + name: pageToken + schema: + type: string + - description: Required. The resource name of the organization or folder whose + folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + Access to this method is controlled by checking the `resourcemanager.folders.list` + permission on the `parent`. + in: query + name: parent + schema: + type: string + - description: Optional. Controls whether folders in the DELETE_REQUESTED state + should be returned. Defaults to false. + in: query + name: showDeleted + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListFoldersResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - folders + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a folder in the resource hierarchy. Returns an `Operation` + which can be used to track the progress of the folder creation workflow. Upon + success, the `Operation.response` field will be populated with the created + Folder. In order to succeed, the addition of this new folder must not violate + the folder naming, height, or fanout constraints. + The folder's `display_name` + must be distinct from all other folders that share its parent. + The addition + of the folder must not cause the active folder hierarchy to exceed a height + of 10. Note, the full active + deleted folder hierarchy is allowed to reach + a height of 20; this provides additional headroom when moving folders that + contain deleted folders. + The addition of the folder must not cause the total + number of folders under its parent to exceed 300. If the operation fails due + to a folder constraint violation, some errors may be returned by the `CreateFolder` + request, with status code `FAILED_PRECONDITION` and an error description. + Other folder constraint violations will be communicated in the `Operation`, + with the specific `PreconditionFailure` returned in the details list in the + `Operation.error` field. The caller must have `resourcemanager.folders.create` + permission on the identified parent. + operationId: cloudresourcemanager.folders.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Folder' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - folders + /v3/folders/{foldersId}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: foldersId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: foldersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/folders/{foldersId}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Gets the access control policy for a TagValue. The returned policy + may be empty if no such policy or resource exists. The `resource` field should + be the TagValue''s resource name. For example: `tagValues/1234`. The caller + must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` + permission on the identified TagValue to get the access control policy.' + operationId: cloudresourcemanager.tagValues.getIamPolicy + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/folders/{foldersId}:move: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Move a project to another place in your resource hierarchy, under + a new resource parent. Returns an operation which can be used to track the + process of the project move workflow. Upon success, the `Operation.response` + field will be populated with the moved project. The caller must have `resourcemanager.projects.move` + permission on the project, on the project''s current and proposed new parent. + If project has no current parent, or it currently does not have an associated + organization resource, you will also need the `resourcemanager.projects.setIamPolicy` + permission in the project. ' + operationId: cloudresourcemanager.projects.move + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MoveProjectRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v3/folders/{foldersId}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Sets the access control policy on a TagValue, replacing any existing + policy. The `resource` field should be the TagValue''s resource name. For + example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` + permission on the identified tagValue.' + operationId: cloudresourcemanager.tagValues.setIamPolicy + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/folders/{foldersId}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Returns permissions that a caller has on the specified TagValue. + The `resource` field should be the TagValue''s resource name. For example: + `tagValues/1234`. There are no permissions required for making this API call.' + operationId: cloudresourcemanager.tagValues.testIamPermissions + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/folders/{foldersId}:undelete: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Restores the project identified by the specified `name` (for example, + `projects/415104041262`). You can only use this method for a project that + has a lifecycle state of DELETE_REQUESTED. After deletion starts, the project + cannot be restored. The caller must have `resourcemanager.projects.undelete` + permission for this project. + operationId: cloudresourcemanager.projects.undelete + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteProjectRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v3/folders:search: + get: + description: Search for folders that match specific filter criteria. `search()` + provides an eventually consistent view of the folders a user has access to + which meet the specified filter criteria. This will only return folders on + which the caller has the permission `resourcemanager.folders.get`. + operationId: cloudresourcemanager.folders.search + parameters: + - description: Optional. The maximum number of folders to return in the response. + The server can return fewer folders than requested. If unspecified, server + picks an appropriate default. + in: query + name: pageSize + schema: + type: integer + - description: Optional. A pagination token returned from a previous call to + `SearchFolders` that indicates from where search should continue. + in: query + name: pageToken + schema: + type: string + - description: 'Optional. Search criteria used to select the folders to return. + If no search criteria is specified then all accessible folders will be returned. + Query expressions can be used to restrict results based upon displayName, + state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can + be used along with the suffix wildcard symbol `*`. The `displayName` field + in a query expression should use escaped quotes for values that include + whitespace to prevent unexpected behavior. | Field | Description | |-------------------------|----------------------------------------| + | displayName | Filters by displayName. | | parent | Filters by parent (for + example: folders/123). | | state, lifecycleState | Filters by state. | Some + example queries are: * Query `displayName=Test*` returns Folder resources + whose display name starts with "Test". * Query `state=ACTIVE` returns Folder + resources with `state` set to `ACTIVE`. * Query `parent=folders/123` returns + Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 + AND state=ACTIVE` returns active Folder resources that have `folders/123` + as a parent resource. * Query `displayName=\\"Test String\\"` returns Folder + resources with display names that include both "Test" and "String".' + in: query + name: query + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SearchFoldersResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - folders + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v3/liens: + get: + description: List all Liens applied to the `parent` resource. Callers of this + method will require permission on the `parent` resource. For example, a Lien + with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`. + operationId: cloudresourcemanager.liens.list + parameters: + - description: The maximum number of items to return. This is a suggestion for + the server. The server can return fewer liens than requested. If unspecified, + server picks an appropriate default. + in: query + name: pageSize + schema: + type: integer + - description: The `next_page_token` value returned from a previous List request, + if any. + in: query + name: pageToken + schema: + type: string + - description: Required. The name of the resource to list all attached Liens. + For example, `projects/1234`. (google.api.field_policy).resource_type annotation + is not set since the parent depends on the meta api implementation. This + field could be a project or other sub project resources. + in: query + name: parent + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListLiensResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - liens + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Create a Lien which applies to the resource denoted by the `parent` + field. Callers of this method will require permission on the `parent` resource. + For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. + NOTE: Some resources may limit the number of Liens which may be applied.' + operationId: cloudresourcemanager.liens.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Lien' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Lien' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - liens + /v3/liens/{liensId}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: liensId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - in: path + name: liensId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: liensId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/operations/{operationsId}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: operationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - in: path + name: operationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: operationsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/organizations/{organizationsId}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: organizationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: organizationsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/organizations/{organizationsId}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Gets the access control policy for a TagValue. The returned policy + may be empty if no such policy or resource exists. The `resource` field should + be the TagValue''s resource name. For example: `tagValues/1234`. The caller + must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` + permission on the identified TagValue to get the access control policy.' + operationId: cloudresourcemanager.tagValues.getIamPolicy + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/organizations/{organizationsId}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Sets the access control policy on a TagValue, replacing any existing + policy. The `resource` field should be the TagValue''s resource name. For + example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` + permission on the identified tagValue.' + operationId: cloudresourcemanager.tagValues.setIamPolicy + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/organizations/{organizationsId}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Returns permissions that a caller has on the specified TagValue. + The `resource` field should be the TagValue''s resource name. For example: + `tagValues/1234`. There are no permissions required for making this API call.' + operationId: cloudresourcemanager.tagValues.testIamPermissions + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/organizations:search: + get: + description: Searches organization resources that are visible to the user and + satisfy the specified filter. This method returns organizations in an unspecified + order. New organizations do not necessarily appear at the end of the results, + and may take a small amount of time to appear. Search will only return organizations + on which the user has the permission `resourcemanager.organizations.get` + operationId: cloudresourcemanager.organizations.search + parameters: + - description: Optional. The maximum number of organizations to return in the + response. The server can return fewer organizations than requested. If unspecified, + server picks an appropriate default. + in: query + name: pageSize + schema: + type: integer + - description: Optional. A pagination token returned from a previous call to + `SearchOrganizations` that indicates from where listing should continue. + in: query + name: pageToken + schema: + type: string + - description: 'Optional. An optional query string used to filter the Organizations + to return in the response. Query rules are case-insensitive. | Field | Description + | |------------------|--------------------------------------------| | directoryCustomerId, + owner.directoryCustomerId | Filters by directory customer id. | | domain + | Filters by domain. | Organizations may be queried by `directoryCustomerId` + or by `domain`, where the domain is a G Suite domain, for example: * Query + `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` + equal to `123456789`. * Query `domain:google.com` returns Organization resources + corresponding to the domain `google.com`.' + in: query + name: query + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SearchOrganizationsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - organizations + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v3/projects: + get: + description: Lists projects that are direct children of the specified folder + or organization resource. `list()` provides a strongly consistent view of + the projects underneath the specified parent resource. `list()` returns projects + sorted based upon the (ascending) lexical ordering of their `display_name`. + The caller must have `resourcemanager.projects.list` permission on the identified + parent. + operationId: cloudresourcemanager.projects.list + parameters: + - description: Optional. The maximum number of projects to return in the response. + The server can return fewer projects than requested. If unspecified, server + picks an appropriate default. + in: query + name: pageSize + schema: + type: integer + - description: Optional. A pagination token returned from a previous call to + ListProjects that indicates from where listing should continue. + in: query + name: pageToken + schema: + type: string + - description: Required. The name of the parent resource to list projects under. + For example, setting this field to 'folders/1234' would list all projects + directly under that folder. + in: query + name: parent + schema: + type: string + - description: Optional. Indicate that projects in the `DELETE_REQUESTED` state + should also be returned. Normally only `ACTIVE` projects are returned. + in: query + name: showDeleted + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListProjectsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Request that a new project be created. The result is an `Operation` + which can be used to track the creation process. This process usually takes + a few seconds, but can sometimes take much longer. The tracking `Operation` + is automatically deleted after a few hours, so there is no need to call `DeleteOperation`. + operationId: cloudresourcemanager.projects.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v3/projects/{projectsId}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: projectsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: projectsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/projects/{projectsId}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Gets the access control policy for a TagValue. The returned policy + may be empty if no such policy or resource exists. The `resource` field should + be the TagValue''s resource name. For example: `tagValues/1234`. The caller + must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` + permission on the identified TagValue to get the access control policy.' + operationId: cloudresourcemanager.tagValues.getIamPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/projects/{projectsId}:move: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Move a project to another place in your resource hierarchy, under + a new resource parent. Returns an operation which can be used to track the + process of the project move workflow. Upon success, the `Operation.response` + field will be populated with the moved project. The caller must have `resourcemanager.projects.move` + permission on the project, on the project''s current and proposed new parent. + If project has no current parent, or it currently does not have an associated + organization resource, you will also need the `resourcemanager.projects.setIamPolicy` + permission in the project. ' + operationId: cloudresourcemanager.projects.move + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MoveProjectRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v3/projects/{projectsId}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Sets the access control policy on a TagValue, replacing any existing + policy. The `resource` field should be the TagValue''s resource name. For + example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` + permission on the identified tagValue.' + operationId: cloudresourcemanager.tagValues.setIamPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/projects/{projectsId}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Returns permissions that a caller has on the specified TagValue. + The `resource` field should be the TagValue''s resource name. For example: + `tagValues/1234`. There are no permissions required for making this API call.' + operationId: cloudresourcemanager.tagValues.testIamPermissions + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/projects/{projectsId}:undelete: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Restores the project identified by the specified `name` (for example, + `projects/415104041262`). You can only use this method for a project that + has a lifecycle state of DELETE_REQUESTED. After deletion starts, the project + cannot be restored. The caller must have `resourcemanager.projects.undelete` + permission for this project. + operationId: cloudresourcemanager.projects.undelete + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteProjectRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v3/projects:search: + get: + description: Search for projects that the caller has both `resourcemanager.projects.get` + permission on, and also satisfy the specified query. This method returns projects + in an unspecified order. This method is eventually consistent with project + mutations; this means that a newly created project may not appear in the results + or recent updates to an existing project may not be reflected in the results. + To retrieve the latest state of a project, use the GetProject method. + operationId: cloudresourcemanager.projects.search + parameters: + - description: Optional. The maximum number of projects to return in the response. + The server can return fewer projects than requested. If unspecified, server + picks an appropriate default. + in: query + name: pageSize + schema: + type: integer + - description: Optional. A pagination token returned from a previous call to + ListProjects that indicates from where listing should continue. + in: query + name: pageToken + schema: + type: string + - description: 'Optional. A query string for searching for projects that the + caller has `resourcemanager.projects.get` permission to. If multiple fields + are included in the query, the it will return results that match any of + the fields. Some eligible fields are: | Field | Description | |-------------------------|----------------------------------------------| + | displayName, name | Filters by displayName. | | parent | Project''s parent + (for example: folders/123, organizations/*). Prefer parent field over parent.type + and parent.id.| | parent.type | Parent''s type: `folder` or `organization`. + | | parent.id | Parent''s id number (for example: 123) | | id, projectId + | Filters by projectId. | | state, lifecycleState | Filters by state. | + | labels | Filters by label name or value. | | labels.\ (where *key* is + the name of a label) | Filters by label name.| Search expressions are case + insensitive. Some examples queries: | Query | Description | |------------------|-----------------------------------------------------| + | name:how* | The project''s name starts with "how". | | name:Howl | The + project''s name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. + | | NAME:howl | Equivalent to above. | | labels.color:* | The project has + the label `color`. | | labels.color:red | The project''s label `color` has + the value `red`. | | labels.color:red labels.size:big | The project''s label + `color` has the value `red` and its label `size` has the value `big`.| If + no query is specified, the call will return projects for which the user + has the `resourcemanager.projects.get` permission.' + in: query + name: query + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SearchProjectsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v3/tagBindings: + get: + description: 'Lists the TagBindings for the given cloud resource, as specified + with `parent`. NOTE: The `parent` field is expected to be a full resource + name: https://cloud.google.com/apis/design/resource_names#full_resource_name' + operationId: cloudresourcemanager.tagBindings.list + parameters: + - description: Optional. The maximum number of TagBindings to return in the + response. The server allows a maximum of 300 TagBindings to return. If unspecified, + the server will use 100 as the default. + in: query + name: pageSize + schema: + type: integer + - description: Optional. A pagination token returned from a previous call to + `ListTagBindings` that indicates where this listing should continue from. + in: query + name: pageToken + schema: + type: string + - description: Required. The full resource name of a resource for which you + want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123" + in: query + name: parent + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagBindingsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagBindings + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a TagBinding between a TagValue and a cloud resource (currently + project, folder, or organization). + operationId: cloudresourcemanager.tagBindings.create + parameters: + - description: Optional. Set to true to perform the validations necessary for + creating the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagBinding' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagBindings + /v3/tagBindings/{tagBindingsId}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: tagBindingsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - in: path + name: tagBindingsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: tagBindingsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/tagKeys: + get: + description: Lists all TagKeys for a parent resource. + operationId: cloudresourcemanager.tagKeys.list + parameters: + - description: Optional. The maximum number of TagKeys to return in the response. + The server allows a maximum of 300 TagKeys to return. If unspecified, the + server will use 100 as the default. + in: query + name: pageSize + schema: + type: integer + - description: Optional. A pagination token returned from a previous call to + `ListTagKey` that indicates where this listing should continue from. + in: query + name: pageToken + schema: + type: string + - description: Required. The resource name of the new TagKey's parent. Must + be of the form `folders/{folder_id}` or `organizations/{org_id}`. + in: query + name: parent + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagKeysResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagKeys + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a new TagKey. If another request with the same parameters + is sent while the original request is in process, the second request will + receive an error. A maximum of 300 TagKeys can exist under a parent at any + given time. + operationId: cloudresourcemanager.tagKeys.create + parameters: + - description: Optional. Set to true to perform validations necessary for creating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagKey' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagKeys + /v3/tagKeys/{tagKeysId}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: tagKeysId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - in: path + name: tagKeysId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: tagKeysId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/tagKeys/{tagKeysId}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Gets the access control policy for a TagValue. The returned policy + may be empty if no such policy or resource exists. The `resource` field should + be the TagValue''s resource name. For example: `tagValues/1234`. The caller + must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` + permission on the identified TagValue to get the access control policy.' + operationId: cloudresourcemanager.tagValues.getIamPolicy + parameters: + - in: path + name: tagKeysId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/tagKeys/{tagKeysId}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Sets the access control policy on a TagValue, replacing any existing + policy. The `resource` field should be the TagValue''s resource name. For + example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` + permission on the identified tagValue.' + operationId: cloudresourcemanager.tagValues.setIamPolicy + parameters: + - in: path + name: tagKeysId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/tagKeys/{tagKeysId}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Returns permissions that a caller has on the specified TagValue. + The `resource` field should be the TagValue''s resource name. For example: + `tagValues/1234`. There are no permissions required for making this API call.' + operationId: cloudresourcemanager.tagValues.testIamPermissions + parameters: + - in: path + name: tagKeysId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/tagValues: + get: + description: Lists all TagValues for a specific TagKey. + operationId: cloudresourcemanager.tagValues.list + parameters: + - description: 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. + in: query + name: pageSize + schema: + type: integer + - description: Optional. A pagination token returned from a previous call to + `ListTagValues` that indicates where this listing should continue from. + in: query + name: pageToken + schema: + type: string + - description: Required. Resource name for TagKey, parent of the TagValues to + be listed, in the format `tagKeys/123`. + in: query + name: parent + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagValuesResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a TagValue as a child of the specified TagKey. If a another + request with the same parameters is sent while the original request is in + process the second request will receive an error. A maximum of 300 TagValues + can exist under a TagKey at any given time. + operationId: cloudresourcemanager.tagValues.create + parameters: + - description: Optional. Set as true to perform the validations necessary for + creating the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/tagValues/{tagValuesId}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: tagValuesId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - in: path + name: tagValuesId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + - in: path + name: tagValuesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/tagValues/{tagValuesId}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Gets the access control policy for a TagValue. The returned policy + may be empty if no such policy or resource exists. The `resource` field should + be the TagValue''s resource name. For example: `tagValues/1234`. The caller + must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` + permission on the identified TagValue to get the access control policy.' + operationId: cloudresourcemanager.tagValues.getIamPolicy + parameters: + - in: path + name: tagValuesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/tagValues/{tagValuesId}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Sets the access control policy on a TagValue, replacing any existing + policy. The `resource` field should be the TagValue''s resource name. For + example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` + permission on the identified tagValue.' + operationId: cloudresourcemanager.tagValues.setIamPolicy + parameters: + - in: path + name: tagValuesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/tagValues/{tagValuesId}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Returns permissions that a caller has on the specified TagValue. + The `resource` field should be the TagValue''s resource name. For example: + `tagValues/1234`. There are no permissions required for making this API call.' + operationId: cloudresourcemanager.tagValues.testIamPermissions + parameters: + - in: path + name: tagValuesId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/{name}: + delete: + description: Deletes a TagValue. The TagValue cannot have any bindings when + it is deleted. + operationId: cloudresourcemanager.tagValues.delete + parameters: + - description: Required. Resource name for TagValue to be deleted in the format + tagValues/456. + in: path + name: name + required: true + schema: + type: string + - description: Optional. The etag known to the client for the expected state + of the TagValue. This is to be used for optimistic concurrency. + in: query + name: etag + schema: + type: string + - description: Optional. Set as true to perform the validations necessary for + deletion, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + get: + description: Retrieves TagValue. If the TagValue or namespaced name does not + exist, or if the user does not have permission to view it, this method will + return `PERMISSION_DENIED`. + operationId: cloudresourcemanager.tagValues.get + parameters: + - description: Required. Resource name for TagValue to be fetched in the format + `tagValues/456`. + in: path + name: name + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + patch: + description: Updates the attributes of the TagValue resource. + operationId: cloudresourcemanager.tagValues.patch + parameters: + - description: Immutable. Resource name for TagValue in the format `tagValues/456`. + in: path + name: name + required: true + schema: + type: string + - description: Optional. Fields to be updated. + in: query + name: updateMask + schema: + type: string + - description: Optional. True to perform validations necessary for updating + the resource, but not actually perform the action. + in: query + name: validateOnly + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagValue' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/{name}:move: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Move a project to another place in your resource hierarchy, under + a new resource parent. Returns an operation which can be used to track the + process of the project move workflow. Upon success, the `Operation.response` + field will be populated with the moved project. The caller must have `resourcemanager.projects.move` + permission on the project, on the project''s current and proposed new parent. + If project has no current parent, or it currently does not have an associated + organization resource, you will also need the `resourcemanager.projects.setIamPolicy` + permission in the project. ' + operationId: cloudresourcemanager.projects.move + parameters: + - description: Required. The name of the project to move. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MoveProjectRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v3/{name}:undelete: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Restores the project identified by the specified `name` (for example, + `projects/415104041262`). You can only use this method for a project that + has a lifecycle state of DELETE_REQUESTED. After deletion starts, the project + cannot be restored. The caller must have `resourcemanager.projects.undelete` + permission for this project. + operationId: cloudresourcemanager.projects.undelete + parameters: + - description: Required. The name of the project (for example, `projects/415104041262`). + Required. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteProjectRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v3/{resource}:getIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Gets the access control policy for a TagValue. The returned policy + may be empty if no such policy or resource exists. The `resource` field should + be the TagValue''s resource name. For example: `tagValues/1234`. The caller + must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` + permission on the identified TagValue to get the access control policy.' + operationId: cloudresourcemanager.tagValues.getIamPolicy + parameters: + - description: 'REQUIRED: The resource for which the policy is being requested. + See the operation documentation for the appropriate value for this field.' + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues + /v3/{resource}:setIamPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Sets the access control policy on a TagValue, replacing any existing + policy. The `resource` field should be the TagValue''s resource name. For + example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` + permission on the identified tagValue.' + operationId: cloudresourcemanager.tagValues.setIamPolicy + parameters: + - description: 'REQUIRED: The resource for which the policy is being specified. + See the operation documentation for the appropriate value for this field.' + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - tagValues + /v3/{resource}:testIamPermissions: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: 'Returns permissions that a caller has on the specified TagValue. + The `resource` field should be the TagValue''s resource name. For example: + `tagValues/1234`. There are no permissions required for making this API call.' + operationId: cloudresourcemanager.tagValues.testIamPermissions + parameters: + - description: 'REQUIRED: The resource for which the policy detail is being + requested. See the operation documentation for the appropriate value for + this field.' + in: path + name: resource + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + tags: + - tagValues +servers: +- url: https://cloudresourcemanager.googleapis.com/ +tags: +- name: folders +- name: liens +- name: operations +- name: organizations +- name: projects +- name: tagBindings +- name: tagKeys +- name: tagValues diff --git a/test/registry/src/googleapis.com/v1/services/cloudresourcemanager-v3.yaml.sig b/test/registry/src/googleapis.com/v1/services/cloudresourcemanager-v3.yaml.sig new file mode 100644 index 00000000..10a257f9 --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services/cloudresourcemanager-v3.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELcOGY3mAKUHLcnvKpoaYPdp+umcMXpfcuWDnlhG9BkvX/ygq5iii+avO3Hd3WHo0kHSATVW5DeoKe7YUsn3RnbM1Q6wXwCCQ== \ No newline at end of file diff --git a/test/registry/src/googleapis.com/v1/services/container-v1.yaml b/test/registry/src/googleapis.com/v1/services/container-v1.yaml new file mode 100644 index 00000000..780ea9c1 --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services/container-v1.yaml @@ -0,0 +1,8603 @@ +components: + parameters: + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + enum: + - '1' + - '2' + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + enum: + - json + - media + - proto + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: API key. Your API key identifies your project and provides you + with API access, quota, and reports. Required unless you provide an OAuth + 2.0 token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: Available to use for quota purposes for server-side applications. + Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + in: query + name: quotaUser + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + schemas: + AcceleratorConfig: + description: AcceleratorConfig represents a Hardware Accelerator request. + properties: + acceleratorCount: + description: The number of the accelerator cards exposed to an instance. + format: int64 + type: string + acceleratorType: + description: The accelerator type resource name. List of supported accelerators + [here](https://cloud.google.com/compute/docs/gpus) + type: string + gpuPartitionSize: + description: Size of partitions to create on the GPU. Valid values are described + in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). + type: string + type: object + AddonsConfig: + description: Configuration for the addons that can be automatically spun up + in the cluster, enabling additional functionality. + properties: + cloudRunConfig: + $ref: '#/components/schemas/CloudRunConfig' + description: Configuration for the Cloud Run addon, which allows the user + to use a managed Knative service. + configConnectorConfig: + $ref: '#/components/schemas/ConfigConnectorConfig' + description: Configuration for the ConfigConnector add-on, a Kubernetes + extension to manage hosted GCP services through the Kubernetes API + dnsCacheConfig: + $ref: '#/components/schemas/DnsCacheConfig' + description: Configuration for NodeLocalDNS, a dns cache running on cluster + nodes + gcePersistentDiskCsiDriverConfig: + $ref: '#/components/schemas/GcePersistentDiskCsiDriverConfig' + description: Configuration for the Compute Engine Persistent Disk CSI driver. + gcpFilestoreCsiDriverConfig: + $ref: '#/components/schemas/GcpFilestoreCsiDriverConfig' + description: Configuration for the GCP Filestore CSI driver. + horizontalPodAutoscaling: + $ref: '#/components/schemas/HorizontalPodAutoscaling' + description: Configuration for the horizontal pod autoscaling feature, which + increases or decreases the number of replica pods a replication controller + has based on the resource usage of the existing pods. + httpLoadBalancing: + $ref: '#/components/schemas/HttpLoadBalancing' + description: Configuration for the HTTP (L7) load balancing controller addon, + which makes it easy to set up HTTP load balancers for services in a cluster. + kubernetesDashboard: + $ref: '#/components/schemas/KubernetesDashboard' + description: 'Configuration for the Kubernetes Dashboard. This addon is + deprecated, and will be disabled in 1.15. It is recommended to use the + Cloud Console to manage and monitor your Kubernetes clusters, workloads + and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards' + networkPolicyConfig: + $ref: '#/components/schemas/NetworkPolicyConfig' + description: Configuration for NetworkPolicy. This only tracks whether the + addon is enabled or not on the Master, it does not track whether network + policy is enabled for the nodes. + type: object + AdvancedMachineFeatures: + description: Specifies options for controlling advanced machine features. + properties: + threadsPerCore: + description: The number of threads per physical core. To disable simultaneous + multithreading (SMT) set this to 1. If unset, the maximum number of threads + supported per core by the underlying processor is assumed. + format: int64 + type: string + type: object + AuthenticatorGroupsConfig: + description: Configuration for returning group information from authenticators. + properties: + enabled: + description: Whether this cluster should return group membership lookups + during authentication using a group of security groups. + type: boolean + securityGroup: + description: The name of the security group-of-groups to be used. Only relevant + if enabled = true. + type: string + type: object + AutoUpgradeOptions: + description: AutoUpgradeOptions defines the set of options for the user to control + how the Auto Upgrades will proceed. + properties: + autoUpgradeStartTime: + description: '[Output only] This field is set when upgrades are about to + commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) + text format.' + type: string + description: + description: '[Output only] This field is set when upgrades are about to + commence with the description of the upgrade.' + type: string + type: object + Autopilot: + description: Autopilot is the configuration for Autopilot settings on the cluster. + properties: + enabled: + description: Enable Autopilot + type: boolean + type: object + AutoprovisioningNodePoolDefaults: + description: AutoprovisioningNodePoolDefaults contains defaults for a node pool + created by NAP. + properties: + bootDiskKmsKey: + description: 'The Customer Managed Encryption Key used to encrypt the boot + disk attached to each node in the node pool. This should be of the form + projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. + For more information about protecting resources with Cloud KMS Keys please + see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption' + type: string + diskSizeGb: + description: Size of the disk attached to each node, specified in GB. The + smallest allowed disk size is 10GB. If unspecified, the default disk size + is 100GB. + format: int32 + type: integer + diskType: + description: Type of the disk attached to each node (e.g. 'pd-standard', + 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' + type: string + imageType: + description: The image type to use for NAP created node. + type: string + management: + $ref: '#/components/schemas/NodeManagement' + description: Specifies the node management options for NAP created node-pools. + minCpuPlatform: + description: 'Minimum CPU platform to be used for NAP created node pools. + The instance may be scheduled on the specified or newer CPU platform. + Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: + Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, + read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + To unset the min cpu platform field pass "automatic" as field value.' + type: string + oauthScopes: + description: Scopes that are used by NAP when creating node pools. + items: + type: string + type: array + serviceAccount: + description: The Google Cloud Platform Service Account to be used by the + node VMs. + type: string + shieldedInstanceConfig: + $ref: '#/components/schemas/ShieldedInstanceConfig' + description: Shielded Instance options. + upgradeSettings: + $ref: '#/components/schemas/UpgradeSettings' + description: Specifies the upgrade settings for NAP created node pools + type: object + BigQueryDestination: + description: Parameters for using BigQuery as the destination of resource usage + export. + properties: + datasetId: + description: The ID of a BigQuery Dataset. + type: string + type: object + BinaryAuthorization: + description: Configuration for Binary Authorization. + properties: + enabled: + description: Enable Binary Authorization for this cluster. If enabled, all + container images will be validated by Binary Authorization. + type: boolean + type: object + CancelOperationRequest: + description: CancelOperationRequest cancels a single operation. + properties: + name: + description: The name (project, location, operation id) of the operation + to cancel. Specified in the format `projects/*/locations/*/operations/*`. + type: string + operationId: + description: Deprecated. The server-assigned `name` of the operation. This + field has been deprecated and replaced by the name field. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the operation resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + CidrBlock: + description: CidrBlock contains an optional name and one CIDR block. + properties: + cidrBlock: + description: cidr_block must be specified in CIDR notation. + type: string + displayName: + description: display_name is an optional field for users to identify CIDR + blocks. + type: string + type: object + ClientCertificateConfig: + description: Configuration for client certificates on the cluster. + properties: + issueClientCertificate: + description: Issue a client certificate. + type: boolean + type: object + CloudRunConfig: + description: Configuration options for the Cloud Run feature. + properties: + disabled: + description: Whether Cloud Run addon is enabled for this cluster. + type: boolean + loadBalancerType: + description: Which load balancer type is installed for Cloud Run. + enum: + - LOAD_BALANCER_TYPE_UNSPECIFIED + - LOAD_BALANCER_TYPE_EXTERNAL + - LOAD_BALANCER_TYPE_INTERNAL + type: string + type: object + Cluster: + description: A Google Kubernetes Engine cluster. + properties: + addonsConfig: + $ref: '#/components/schemas/AddonsConfig' + description: Configurations for the various addons available to run in the + cluster. + authenticatorGroupsConfig: + $ref: '#/components/schemas/AuthenticatorGroupsConfig' + description: Configuration controlling RBAC group membership information. + autopilot: + $ref: '#/components/schemas/Autopilot' + description: Autopilot configuration for the cluster. + autoscaling: + $ref: '#/components/schemas/ClusterAutoscaling' + description: Cluster-level autoscaling configuration. + binaryAuthorization: + $ref: '#/components/schemas/BinaryAuthorization' + description: Configuration for Binary Authorization. + clusterIpv4Cidr: + description: The IP address range of the container pods in this cluster, + in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically + chosen or specify a `/14` block in `10.0.0.0/8`. + type: string + conditions: + description: Which conditions caused the current cluster state. + items: + $ref: '#/components/schemas/StatusCondition' + type: array + confidentialNodes: + $ref: '#/components/schemas/ConfidentialNodes' + description: Configuration of Confidential Nodes + createTime: + description: '[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) + text format.' + type: string + currentMasterVersion: + description: '[Output only] The current software version of the master endpoint.' + type: string + currentNodeCount: + description: '[Output only] The number of nodes currently in the cluster. + Deprecated. Call Kubernetes API directly to retrieve node information.' + format: int32 + type: integer + currentNodeVersion: + description: '[Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) + instead. The current version of the node software components. If they + are currently at multiple versions because they''re in the process of + being upgraded, this reflects the minimum version of all nodes.' + type: string + databaseEncryption: + $ref: '#/components/schemas/DatabaseEncryption' + description: Configuration of etcd encryption. + defaultMaxPodsConstraint: + $ref: '#/components/schemas/MaxPodsConstraint' + description: The default constraint on the maximum number of pods that can + be run simultaneously on a node in the node pool of this cluster. Only + honored if cluster created with IP Alias support. + description: + description: An optional description of this cluster. + type: string + enableKubernetesAlpha: + description: Kubernetes alpha features are enabled on this cluster. This + includes alpha API groups (e.g. v1alpha1) and features that may not be + production ready in the kubernetes version of the master and nodes. The + cluster has no SLA for uptime and master/node upgrades are disabled. Alpha + enabled clusters are automatically deleted thirty days after creation. + type: boolean + enableTpu: + description: Enable the ability to use Cloud TPUs in this cluster. + type: boolean + endpoint: + description: '[Output only] The IP address of this cluster''s master endpoint. + The endpoint can be accessed from the internet at `https://username:password@endpoint/`. + See the `masterAuth` property of this resource for username and password + information.' + type: string + expireTime: + description: '[Output only] The time the cluster will be automatically deleted + in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.' + type: string + id: + description: Output only. Unique id for the cluster. + readOnly: true + type: string + initialClusterVersion: + description: 'The initial Kubernetes version for this cluster. Valid versions + are those found in validMasterVersions returned by getServerConfig. The + version can be upgraded over time; such upgrades are reflected in currentMasterVersion + and currentNodeVersion. Users may specify either explicit versions offered + by Kubernetes Engine or version aliases, which have the following behavior: + - "latest": picks the highest valid Kubernetes version - "1.X": picks + the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks + the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks + an explicit Kubernetes version - "","-": picks the default Kubernetes + version' + type: string + initialNodeCount: + description: The number of nodes to create in this cluster. You must ensure + that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) + is sufficient for this number of instances. You must also have available + firewall and routes quota. For requests, this field should only be used + in lieu of a "node_pool" object, since this configuration (along with + the "node_config") will be used to create a "NodePool" object with an + auto-generated name. Do not use this and a node_pool at the same time. + This field is deprecated, use node_pool.initial_node_count instead. + format: int32 + type: integer + instanceGroupUrls: + description: Deprecated. Use node_pools.instance_group_urls. + items: + type: string + type: array + ipAllocationPolicy: + $ref: '#/components/schemas/IPAllocationPolicy' + description: Configuration for cluster IP allocation. + labelFingerprint: + description: The fingerprint of the set of labels for this cluster. + type: string + legacyAbac: + $ref: '#/components/schemas/LegacyAbac' + description: Configuration for the legacy ABAC authorization mode. + location: + description: '[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) + or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) + in which the cluster resides.' + type: string + locations: + description: 'The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) + in which the cluster''s nodes should be located. This field provides a + default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) + are not specified during node pool creation. Warning: changing cluster + locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) + of all node pools and will result in nodes being added and/or removed.' + items: + type: string + type: array + loggingConfig: + $ref: '#/components/schemas/LoggingConfig' + description: Logging configuration for the cluster. + loggingService: + description: 'The logging service the cluster should use to write logs. + Currently available options: * `logging.googleapis.com/kubernetes` - The + Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` + - The legacy Cloud Logging service (no longer available as of GKE 1.15). + * `none` - no logs will be exported from the cluster. If left as an empty + string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ + or `logging.googleapis.com` for earlier versions.' + type: string + maintenancePolicy: + $ref: '#/components/schemas/MaintenancePolicy' + description: Configure the maintenance policy for this cluster. + masterAuth: + $ref: '#/components/schemas/MasterAuth' + description: 'The authentication information for accessing the master endpoint. + If unspecified, the defaults are used: For clusters before v1.12, if master_auth + is unspecified, `username` will be set to "admin", a random password will + be generated, and a client certificate will be issued.' + masterAuthorizedNetworksConfig: + $ref: '#/components/schemas/MasterAuthorizedNetworksConfig' + description: The configuration options for master authorized networks feature. + meshCertificates: + $ref: '#/components/schemas/MeshCertificates' + description: Configuration for issuance of mTLS keys and certificates to + Kubernetes pods. + monitoringConfig: + $ref: '#/components/schemas/MonitoringConfig' + description: Monitoring configuration for the cluster. + monitoringService: + description: 'The monitoring service the cluster should use to write metrics. + Currently available options: * "monitoring.googleapis.com/kubernetes" + - The Cloud Monitoring service with a Kubernetes-native resource model + * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + longer available as of GKE 1.15). * `none` - No metrics will be exported + from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` + will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier + versions.' + type: string + name: + description: 'The name of this cluster. The name must be unique within this + project and location (e.g. zone or region), and can be up to 40 characters + with the following restrictions: * Lowercase letters, numbers, and hyphens + only. * Must start with a letter. * Must end with a number or a letter.' + type: string + network: + description: The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + to which the cluster is connected. If left unspecified, the `default` + network will be used. + type: string + networkConfig: + $ref: '#/components/schemas/NetworkConfig' + description: Configuration for cluster networking. + networkPolicy: + $ref: '#/components/schemas/NetworkPolicy' + description: Configuration options for the NetworkPolicy feature. + nodeConfig: + $ref: '#/components/schemas/NodeConfig' + description: Parameters used in creating the cluster's nodes. For requests, + this field should only be used in lieu of a "node_pool" object, since + this configuration (along with the "initial_node_count") will be used + to create a "NodePool" object with an auto-generated name. Do not use + this and a node_pool at the same time. For responses, this field will + be populated with the node configuration of the first node pool. (For + configuration of each node pool, see `node_pool.config`) If unspecified, + the defaults are used. This field is deprecated, use node_pool.config + instead. + nodeIpv4CidrSize: + description: '[Output only] The size of the address space on each node for + hosting containers. This is provisioned from within the `container_ipv4_cidr` + range. This field will only be set when cluster is in route-based network + mode.' + format: int32 + type: integer + nodePoolDefaults: + $ref: '#/components/schemas/NodePoolDefaults' + description: Default NodePool settings for the entire cluster. These settings + are overridden if specified on the specific NodePool object. + nodePools: + description: The node pools associated with this cluster. This field should + not be set if "node_config" or "initial_node_count" are specified. + items: + $ref: '#/components/schemas/NodePool' + type: array + notificationConfig: + $ref: '#/components/schemas/NotificationConfig' + description: Notification configuration of the cluster. + privateClusterConfig: + $ref: '#/components/schemas/PrivateClusterConfig' + description: Configuration for private cluster. + releaseChannel: + $ref: '#/components/schemas/ReleaseChannel' + description: Release channel configuration. + resourceLabels: + additionalProperties: + type: string + description: The resource labels for the cluster to use to annotate any + related Google Compute Engine resources. + type: object + resourceUsageExportConfig: + $ref: '#/components/schemas/ResourceUsageExportConfig' + description: Configuration for exporting resource usages. Resource usage + export is disabled when this config is unspecified. + selfLink: + description: '[Output only] Server-defined URL for the resource.' + type: string + servicesIpv4Cidr: + description: '[Output only] The IP address range of the Kubernetes services + in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the + last `/16` from the container CIDR.' + type: string + shieldedNodes: + $ref: '#/components/schemas/ShieldedNodes' + description: Shielded Nodes configuration. + status: + description: '[Output only] The current status of this cluster.' + enum: + - STATUS_UNSPECIFIED + - PROVISIONING + - RUNNING + - RECONCILING + - STOPPING + - ERROR + - DEGRADED + type: string + statusMessage: + description: '[Output only] Deprecated. Use conditions instead. Additional + information about the current status of this cluster, if available.' + type: string + subnetwork: + description: The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) + to which the cluster is connected. + type: string + tpuIpv4CidrBlock: + description: '[Output only] The IP address range of the Cloud TPUs in this + cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + notation (e.g. `1.2.3.4/29`).' + type: string + verticalPodAutoscaling: + $ref: '#/components/schemas/VerticalPodAutoscaling' + description: Cluster-level Vertical Pod Autoscaling configuration. + workloadIdentityConfig: + $ref: '#/components/schemas/WorkloadIdentityConfig' + description: Configuration for the use of Kubernetes Service Accounts in + GCP IAM policies. + zone: + description: '[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field is deprecated, use location instead.' + type: string + type: object + ClusterAutoscaling: + description: ClusterAutoscaling contains global, per-cluster information required + by Cluster Autoscaler to automatically adjust the size of the cluster and + create/delete node pools based on the current needs. + properties: + autoprovisioningLocations: + description: The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) + in which the NodePool's nodes can be created by NAP. + items: + type: string + type: array + autoprovisioningNodePoolDefaults: + $ref: '#/components/schemas/AutoprovisioningNodePoolDefaults' + description: AutoprovisioningNodePoolDefaults contains defaults for a node + pool created by NAP. + autoscalingProfile: + description: Defines autoscaling behaviour. + enum: + - PROFILE_UNSPECIFIED + - OPTIMIZE_UTILIZATION + - BALANCED + type: string + enableNodeAutoprovisioning: + description: Enables automatic node pool creation and deletion. + type: boolean + resourceLimits: + description: Contains global constraints regarding minimum and maximum amount + of resources in the cluster. + items: + $ref: '#/components/schemas/ResourceLimit' + type: array + type: object + ClusterUpdate: + description: ClusterUpdate describes an update to the cluster. Exactly one update + can be applied to a cluster with each request, so at most one field can be + provided. + properties: + desiredAddonsConfig: + $ref: '#/components/schemas/AddonsConfig' + description: Configurations for the various addons available to run in the + cluster. + desiredAuthenticatorGroupsConfig: + $ref: '#/components/schemas/AuthenticatorGroupsConfig' + description: The desired authenticator groups config for the cluster. + desiredBinaryAuthorization: + $ref: '#/components/schemas/BinaryAuthorization' + description: The desired configuration options for the Binary Authorization + feature. + desiredClusterAutoscaling: + $ref: '#/components/schemas/ClusterAutoscaling' + description: Cluster-level autoscaling configuration. + desiredDatabaseEncryption: + $ref: '#/components/schemas/DatabaseEncryption' + description: Configuration of etcd encryption. + desiredDatapathProvider: + description: The desired datapath provider for the cluster. + enum: + - DATAPATH_PROVIDER_UNSPECIFIED + - LEGACY_DATAPATH + - ADVANCED_DATAPATH + type: string + desiredDefaultSnatStatus: + $ref: '#/components/schemas/DefaultSnatStatus' + description: The desired status of whether to disable default sNAT for this + cluster. + desiredDnsConfig: + $ref: '#/components/schemas/DNSConfig' + description: DNSConfig contains clusterDNS config for this cluster. + desiredGcfsConfig: + $ref: '#/components/schemas/GcfsConfig' + description: The desired GCFS config for the cluster + desiredImageType: + description: 'The desired image type for the node pool. NOTE: Set the "desired_node_pool" + field as well.' + type: string + desiredIntraNodeVisibilityConfig: + $ref: '#/components/schemas/IntraNodeVisibilityConfig' + description: The desired config of Intra-node visibility. + desiredL4ilbSubsettingConfig: + $ref: '#/components/schemas/ILBSubsettingConfig' + description: The desired L4 Internal Load Balancer Subsetting configuration. + desiredLocations: + description: 'The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) + in which the cluster''s nodes should be located. This list must always + include the cluster''s primary zone. Warning: changing cluster locations + will update the locations of all node pools and will result in nodes being + added and/or removed.' + items: + type: string + type: array + desiredLoggingConfig: + $ref: '#/components/schemas/LoggingConfig' + description: The desired logging configuration. + desiredLoggingService: + description: 'The logging service the cluster should use to write logs. + Currently available options: * `logging.googleapis.com/kubernetes` - The + Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` + - The legacy Cloud Logging service (no longer available as of GKE 1.15). + * `none` - no logs will be exported from the cluster. If left as an empty + string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ + or `logging.googleapis.com` for earlier versions.' + type: string + desiredMasterAuthorizedNetworksConfig: + $ref: '#/components/schemas/MasterAuthorizedNetworksConfig' + description: The desired configuration options for master authorized networks + feature. + desiredMasterVersion: + description: 'The Kubernetes version to change the master to. Users may + specify either explicit versions offered by Kubernetes Engine or version + aliases, which have the following behavior: - "latest": picks the highest + valid Kubernetes version - "1.X": picks the highest valid patch+gke.N + patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch + in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version + - "-": picks the default Kubernetes version' + type: string + desiredMeshCertificates: + $ref: '#/components/schemas/MeshCertificates' + description: Configuration for issuance of mTLS keys and certificates to + Kubernetes pods. + desiredMonitoringConfig: + $ref: '#/components/schemas/MonitoringConfig' + description: The desired monitoring configuration. + desiredMonitoringService: + description: 'The monitoring service the cluster should use to write metrics. + Currently available options: * "monitoring.googleapis.com/kubernetes" + - The Cloud Monitoring service with a Kubernetes-native resource model + * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + longer available as of GKE 1.15). * `none` - No metrics will be exported + from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` + will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier + versions.' + type: string + desiredNodePoolAutoscaling: + $ref: '#/components/schemas/NodePoolAutoscaling' + description: Autoscaler configuration for the node pool specified in desired_node_pool_id. + If there is only one pool in the cluster and desired_node_pool_id is not + provided then the change applies to that single node pool. + desiredNodePoolId: + description: The node pool to be upgraded. This field is mandatory if "desired_node_version", + "desired_image_family" or "desired_node_pool_autoscaling" is specified + and there is more than one node pool on the cluster. + type: string + desiredNodeVersion: + description: 'The Kubernetes version to change the nodes to (typically an + upgrade). Users may specify either explicit versions offered by Kubernetes + Engine or version aliases, which have the following behavior: - "latest": + picks the highest valid Kubernetes version - "1.X": picks the highest + valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest + valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit + Kubernetes version - "-": picks the Kubernetes master version' + type: string + desiredNotificationConfig: + $ref: '#/components/schemas/NotificationConfig' + description: The desired notification configuration. + desiredPrivateClusterConfig: + $ref: '#/components/schemas/PrivateClusterConfig' + description: The desired private cluster configuration. + desiredPrivateIpv6GoogleAccess: + description: The desired state of IPv6 connectivity to Google Services. + enum: + - PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED + - PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED + - PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE + - PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL + type: string + desiredReleaseChannel: + $ref: '#/components/schemas/ReleaseChannel' + description: The desired release channel configuration. + desiredResourceUsageExportConfig: + $ref: '#/components/schemas/ResourceUsageExportConfig' + description: The desired configuration for exporting resource usage. + desiredShieldedNodes: + $ref: '#/components/schemas/ShieldedNodes' + description: Configuration for Shielded Nodes. + desiredVerticalPodAutoscaling: + $ref: '#/components/schemas/VerticalPodAutoscaling' + description: Cluster-level Vertical Pod Autoscaling configuration. + desiredWorkloadIdentityConfig: + $ref: '#/components/schemas/WorkloadIdentityConfig' + description: Configuration for Workload Identity. + type: object + CompleteIPRotationRequest: + description: CompleteIPRotationRequest moves the cluster master back into single-IP + mode. + properties: + clusterId: + description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + type: string + name: + description: The name (project, location, cluster id) of the cluster to + complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + ConfidentialNodes: + description: ConfidentialNodes is configuration for the confidential nodes feature, + which makes nodes run on confidential VMs. + properties: + enabled: + description: Whether Confidential Nodes feature is enabled for all nodes + in this cluster. + type: boolean + type: object + ConfigConnectorConfig: + description: Configuration options for the Config Connector add-on. + properties: + enabled: + description: Whether Cloud Connector is enabled for this cluster. + type: boolean + type: object + ConsumptionMeteringConfig: + description: Parameters for controlling consumption metering. + properties: + enabled: + description: Whether to enable consumption metering for this cluster. If + enabled, a second BigQuery table will be created to hold resource consumption + records. + type: boolean + type: object + CreateClusterRequest: + description: CreateClusterRequest creates a cluster. + properties: + cluster: + $ref: '#/components/schemas/Cluster' + description: Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters) + parent: + description: The parent (project and location) where the cluster will be + created. Specified in the format `projects/*/locations/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the parent field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the parent field. + type: string + type: object + CreateNodePoolRequest: + description: CreateNodePoolRequest creates a node pool for a cluster. + properties: + clusterId: + description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the parent field. + type: string + nodePool: + $ref: '#/components/schemas/NodePool' + description: Required. The node pool to create. + parent: + description: The parent (project, location, cluster id) where the node pool + will be created. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the parent field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the parent field. + type: string + type: object + DNSConfig: + description: DNSConfig contains the desired set of options for configuring clusterDNS. + properties: + clusterDns: + description: cluster_dns indicates which in-cluster DNS provider should + be used. + enum: + - PROVIDER_UNSPECIFIED + - PLATFORM_DEFAULT + - CLOUD_DNS + type: string + clusterDnsDomain: + description: cluster_dns_domain is the suffix used for all cluster service + records. + type: string + clusterDnsScope: + description: cluster_dns_scope indicates the scope of access to cluster + DNS records. + enum: + - DNS_SCOPE_UNSPECIFIED + - VPC_SCOPE + type: string + type: object + DailyMaintenanceWindow: + description: Time window specified for daily maintenance operations. + properties: + duration: + description: '[Output only] Duration of the time window, automatically chosen + to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) + format "PTnHnMnS".' + type: string + startTime: + description: 'Time within the maintenance window to start the maintenance + operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) + format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.' + type: string + type: object + DatabaseEncryption: + description: Configuration of etcd encryption. + properties: + keyName: + description: Name of CloudKMS key to use for the encryption of secrets in + etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key + type: string + state: + description: Denotes the state of etcd encryption. + enum: + - UNKNOWN + - ENCRYPTED + - DECRYPTED + type: string + type: object + DefaultSnatStatus: + description: DefaultSnatStatus contains the desired state of whether default + sNAT should be disabled on the cluster. + properties: + disabled: + description: Disables cluster default sNAT rules. + type: boolean + type: object + DnsCacheConfig: + description: Configuration for NodeLocal DNSCache + properties: + enabled: + description: Whether NodeLocal DNSCache is enabled for this cluster. + type: boolean + type: object + Empty: + description: 'A generic empty message that you can re-use to avoid defining + duplicated empty messages in your APIs. A typical example is to use it as + the request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON + representation for `Empty` is empty JSON object `{}`.' + properties: {} + type: object + GcePersistentDiskCsiDriverConfig: + description: Configuration for the Compute Engine PD CSI driver. + properties: + enabled: + description: Whether the Compute Engine PD CSI driver is enabled for this + cluster. + type: boolean + type: object + GcfsConfig: + description: GcfsConfig contains configurations of Google Container File System + (image streaming). + properties: + enabled: + description: Whether to use GCFS. + type: boolean + type: object + GcpFilestoreCsiDriverConfig: + description: Configuration for the GCP Filestore CSI driver. + properties: + enabled: + description: Whether the GCP Filestore CSI driver is enabled for this cluster. + type: boolean + type: object + GetJSONWebKeysResponse: + description: GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed + in rfc 7517 + properties: + cacheHeader: + $ref: '#/components/schemas/HttpCacheControlResponseHeader' + description: OnePlatform automatically extracts this field and uses it to + set the HTTP Cache-Control header. + keys: + description: The public component of the keys used by the cluster to sign + token requests. + items: + $ref: '#/components/schemas/Jwk' + type: array + type: object + GetOpenIDConfigResponse: + description: GetOpenIDConfigResponse is an OIDC discovery document for the cluster. + See the OpenID Connect Discovery 1.0 specification for details. + properties: + cacheHeader: + $ref: '#/components/schemas/HttpCacheControlResponseHeader' + description: OnePlatform automatically extracts this field and uses it to + set the HTTP Cache-Control header. + claims_supported: + description: Supported claims. + items: + type: string + type: array + grant_types: + description: Supported grant types. + items: + type: string + type: array + id_token_signing_alg_values_supported: + description: supported ID Token signing Algorithms. + items: + type: string + type: array + issuer: + description: OIDC Issuer. + type: string + jwks_uri: + description: JSON Web Key uri. + type: string + response_types_supported: + description: Supported response types. + items: + type: string + type: array + subject_types_supported: + description: Supported subject types. + items: + type: string + type: array + type: object + HorizontalPodAutoscaling: + description: Configuration options for the horizontal pod autoscaling feature, + which increases or decreases the number of replica pods a replication controller + has based on the resource usage of the existing pods. + properties: + disabled: + description: Whether the Horizontal Pod Autoscaling feature is enabled in + the cluster. When enabled, it ensures that metrics are collected into + Stackdriver Monitoring. + type: boolean + type: object + HttpCacheControlResponseHeader: + description: 'RFC-2616: cache control support' + properties: + age: + description: 14.6 response cache age, in seconds since the response is generated + format: int64 + type: string + directive: + description: 14.9 request and response directives + type: string + expires: + description: 14.21 response cache expires, in RFC 1123 date format + type: string + type: object + HttpLoadBalancing: + description: Configuration options for the HTTP (L7) load balancing controller + addon, which makes it easy to set up HTTP load balancers for services in a + cluster. + properties: + disabled: + description: Whether the HTTP Load Balancing controller is enabled in the + cluster. When enabled, it runs a small pod in the cluster that manages + the load balancers. + type: boolean + type: object + ILBSubsettingConfig: + description: ILBSubsettingConfig contains the desired config of L4 Internal + LoadBalancer subsetting on this cluster. + properties: + enabled: + description: Enables l4 ILB subsetting for this cluster. + type: boolean + type: object + IPAllocationPolicy: + description: Configuration for controlling how IPs are allocated in the cluster. + properties: + clusterIpv4Cidr: + description: This field is deprecated, use cluster_ipv4_cidr_block. + type: string + clusterIpv4CidrBlock: + description: 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. + type: string + clusterSecondaryRangeName: + description: 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. + type: string + createSubnetwork: + description: Whether a new subnetwork will be created automatically for + the cluster. This field is only applicable when `use_ip_aliases` is true. + type: boolean + nodeIpv4Cidr: + description: This field is deprecated, use node_ipv4_cidr_block. + type: string + nodeIpv4CidrBlock: + description: 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. + type: string + servicesIpv4Cidr: + description: This field is deprecated, use services_ipv4_cidr_block. + type: string + servicesIpv4CidrBlock: + description: The IP address range of the services IPs in this cluster. If + blank, a range will be automatically chosen with the default size. 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. + type: string + servicesSecondaryRangeName: + description: The name of the secondary range to be used as for the services + CIDR block. The secondary range will be used for service ClusterIPs. 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. + type: string + subnetworkName: + description: A custom subnetwork name to be used if `create_subnetwork` + is true. If this field is empty, then an automatic name will be chosen + for the new subnetwork. + type: string + tpuIpv4CidrBlock: + description: The IP address range of the Cloud TPUs in this cluster. If + unspecified, a range will be automatically chosen with the default size. + This field is only applicable when `use_ip_aliases` is true. If unspecified, + the range will use 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. + type: string + useIpAliases: + description: Whether alias IPs will be used for pod IPs in the cluster. + This is used in conjunction with use_routes. It cannot be true if use_routes + is true. If both use_ip_aliases and use_routes are false, then the server + picks the default IP allocation mode + type: boolean + useRoutes: + description: Whether routes will be used for pod IPs in the cluster. This + is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases + is true. If both use_ip_aliases and use_routes are false, then the server + picks the default IP allocation mode + type: boolean + type: object + IntraNodeVisibilityConfig: + description: IntraNodeVisibilityConfig contains the desired config of the intra-node + visibility on this cluster. + properties: + enabled: + description: Enables intra node visibility for this cluster. + type: boolean + type: object + Jwk: + description: Jwk is a JSON Web Key as specified in RFC 7517 + properties: + alg: + description: Algorithm. + type: string + crv: + description: Used for ECDSA keys. + type: string + e: + description: Used for RSA keys. + type: string + kid: + description: Key ID. + type: string + kty: + description: Key Type. + type: string + n: + description: Used for RSA keys. + type: string + use: + description: Permitted uses for the public keys. + type: string + x: + description: Used for ECDSA keys. + type: string + y: + description: Used for ECDSA keys. + type: string + type: object + KubernetesDashboard: + description: Configuration for the Kubernetes Dashboard. + properties: + disabled: + description: Whether the Kubernetes Dashboard is enabled for this cluster. + type: boolean + type: object + LegacyAbac: + description: Configuration for the legacy Attribute Based Access Control authorization + mode. + properties: + enabled: + description: Whether the ABAC authorizer is enabled for this cluster. When + enabled, identities in the system, including service accounts, nodes, + and controllers, will have statically granted permissions beyond those + provided by the RBAC configuration or IAM. + type: boolean + type: object + LinuxNodeConfig: + description: Parameters that can be configured on Linux nodes. + properties: + sysctls: + additionalProperties: + type: string + description: The Linux kernel parameters to be applied to the nodes and + all pods running on the nodes. The following parameters are supported. + net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max + net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem + net.ipv4.tcp_tw_reuse + type: object + type: object + ListClustersResponse: + description: ListClustersResponse is the result of ListClustersRequest. + properties: + clusters: + description: A list of clusters in the project in the specified zone, or + across all ones. + items: + $ref: '#/components/schemas/Cluster' + type: array + missingZones: + description: If any zones are listed here, the list of clusters returned + may be missing those zones. + items: + type: string + type: array + type: object + ListNodePoolsResponse: + description: ListNodePoolsResponse is the result of ListNodePoolsRequest. + properties: + nodePools: + description: A list of node pools for a cluster. + items: + $ref: '#/components/schemas/NodePool' + type: array + type: object + ListOperationsResponse: + description: ListOperationsResponse is the result of ListOperationsRequest. + properties: + missingZones: + description: If any zones are listed here, the list of operations returned + may be missing the operations from those zones. + items: + type: string + type: array + operations: + description: A list of operations in the project in the specified zone. + items: + $ref: '#/components/schemas/Operation' + type: array + type: object + ListUsableSubnetworksResponse: + description: ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. + properties: + nextPageToken: + description: This token allows you to get the next page of results for list + requests. If the number of results is larger than `page_size`, use the + `next_page_token` as a value for the query parameter `page_token` in the + next request. The value will become empty when there are no more pages. + type: string + subnetworks: + description: A list of usable subnetworks in the specified network project. + items: + $ref: '#/components/schemas/UsableSubnetwork' + type: array + type: object + LoggingComponentConfig: + description: LoggingComponentConfig is cluster logging component configuration. + properties: + enableComponents: + description: Select components to collect logs. An empty set would disable + all logging. + items: + enum: + - COMPONENT_UNSPECIFIED + - SYSTEM_COMPONENTS + - WORKLOADS + type: string + type: array + type: object + LoggingConfig: + description: LoggingConfig is cluster logging configuration. + properties: + componentConfig: + $ref: '#/components/schemas/LoggingComponentConfig' + description: Logging components configuration + type: object + MaintenancePolicy: + description: MaintenancePolicy defines the maintenance policy to be used for + the cluster. + properties: + resourceVersion: + description: A hash identifying the version of this policy, so that updates + to fields of the policy won't accidentally undo intermediate changes (and + so that users of the API unaware of some fields won't accidentally remove + other fields). Make a `get()` request to the cluster to get the current + resource version and include it with requests to set the policy. + type: string + window: + $ref: '#/components/schemas/MaintenanceWindow' + description: Specifies the maintenance window in which maintenance may be + performed. + type: object + MaintenanceWindow: + description: MaintenanceWindow defines the maintenance window to be used for + the cluster. + properties: + dailyMaintenanceWindow: + $ref: '#/components/schemas/DailyMaintenanceWindow' + description: DailyMaintenanceWindow specifies a daily maintenance operation + window. + maintenanceExclusions: + additionalProperties: + $ref: '#/components/schemas/TimeWindow' + description: Exceptions to maintenance window. Non-emergency maintenance + should not occur in these windows. + type: object + recurringWindow: + $ref: '#/components/schemas/RecurringTimeWindow' + description: RecurringWindow specifies some number of recurring time periods + for maintenance to occur. The time windows may be overlapping. If no maintenance + windows are set, maintenance can occur at any time. + type: object + MasterAuth: + description: The authentication information for accessing the master endpoint. + Authentication can be done using HTTP basic auth or using client certificates. + properties: + clientCertificate: + description: '[Output only] Base64-encoded public certificate used by clients + to authenticate to the cluster endpoint.' + type: string + clientCertificateConfig: + $ref: '#/components/schemas/ClientCertificateConfig' + description: Configuration for client certificate authentication on the + cluster. For clusters before v1.12, if no configuration is specified, + a client certificate is issued. + clientKey: + description: '[Output only] Base64-encoded private key used by clients to + authenticate to the cluster endpoint.' + type: string + clusterCaCertificate: + description: '[Output only] Base64-encoded public certificate that is the + root of trust for the cluster.' + type: string + password: + description: 'The password to use for HTTP basic authentication to the master + endpoint. Because the master endpoint is open to the Internet, you should + create a strong password. If a password is provided for cluster creation, + username must be non-empty. Warning: basic authentication is deprecated, + and will be removed in GKE control plane versions 1.19 and newer. For + a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication' + type: string + username: + description: 'The username to use for HTTP basic authentication to the master + endpoint. For clusters v1.6.0 and later, basic authentication can be disabled + by leaving username unspecified (or setting it to the empty string). Warning: + basic authentication is deprecated, and will be removed in GKE control + plane versions 1.19 and newer. For a list of recommended authentication + methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication' + type: string + type: object + MasterAuthorizedNetworksConfig: + description: Configuration options for the master authorized networks feature. + Enabled master authorized networks will disallow all external traffic to access + Kubernetes master through HTTPS except traffic from the given CIDR blocks, + Google Compute Engine Public IPs and Google Prod IPs. + properties: + cidrBlocks: + description: cidr_blocks define up to 50 external networks that could access + Kubernetes master through HTTPS. + items: + $ref: '#/components/schemas/CidrBlock' + type: array + enabled: + description: Whether or not master authorized networks is enabled. + type: boolean + type: object + MaxPodsConstraint: + description: Constraints applied to pods. + properties: + maxPodsPerNode: + description: Constraint enforced on the max num of pods per node. + format: int64 + type: string + type: object + MeshCertificates: + description: Configuration for issuance of mTLS keys and certificates to Kubernetes + pods. + properties: + enableCertificates: + description: 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). + type: boolean + type: object + Metric: + description: Progress metric is (string, int|float|string) pair. + properties: + doubleValue: + description: For metrics with floating point value. + format: double + type: number + intValue: + description: For metrics with integer value. + format: int64 + type: string + name: + description: Required. Metric name, e.g., "nodes total", "percent done". + type: string + stringValue: + description: For metrics with custom values (ratios, visual progress, etc.). + type: string + type: object + MonitoringComponentConfig: + description: MonitoringComponentConfig is cluster monitoring component configuration. + properties: + enableComponents: + description: Select components to collect metrics. An empty set would disable + all monitoring. + items: + enum: + - COMPONENT_UNSPECIFIED + - SYSTEM_COMPONENTS + type: string + type: array + type: object + MonitoringConfig: + description: MonitoringConfig is cluster monitoring configuration. + properties: + componentConfig: + $ref: '#/components/schemas/MonitoringComponentConfig' + description: Monitoring components configuration + type: object + NetworkConfig: + description: NetworkConfig reports the relative names of network & subnetwork. + properties: + datapathProvider: + description: The desired datapath provider for this cluster. By default, + uses the IPTables-based kube-proxy implementation. + enum: + - DATAPATH_PROVIDER_UNSPECIFIED + - LEGACY_DATAPATH + - ADVANCED_DATAPATH + type: string + defaultSnatStatus: + $ref: '#/components/schemas/DefaultSnatStatus' + description: Whether the cluster disables default in-node sNAT rules. In-node + sNAT rules will be disabled when default_snat_status is disabled. When + disabled is set to false, default IP masquerade rules will be applied + to the nodes to prevent sNAT on cluster internal traffic. + dnsConfig: + $ref: '#/components/schemas/DNSConfig' + description: DNSConfig contains clusterDNS config for this cluster. + enableIntraNodeVisibility: + description: Whether Intra-node visibility is enabled for this cluster. + This makes same node pod to pod traffic visible for VPC network. + type: boolean + enableL4ilbSubsetting: + description: Whether L4ILB Subsetting is enabled for this cluster. + type: boolean + network: + description: 'Output only. The relative name of the Google Compute Engine + network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + to which the cluster is connected. Example: projects/my-project/global/networks/my-network' + type: string + privateIpv6GoogleAccess: + description: The desired state of IPv6 connectivity to Google Services. + By default, no private IPv6 access to or from Google Services (all access + will be via IPv4) + enum: + - PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED + - PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED + - PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE + - PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL + type: string + subnetwork: + description: 'Output only. The relative name of the Google Compute Engine + [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster + is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet' + type: string + type: object + NetworkPolicy: + description: Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ + properties: + enabled: + description: Whether network policy is enabled on the cluster. + type: boolean + provider: + description: The selected network policy provider. + enum: + - PROVIDER_UNSPECIFIED + - CALICO + type: string + type: object + NetworkPolicyConfig: + description: Configuration for NetworkPolicy. This only tracks whether the addon + is enabled or not on the Master, it does not track whether network policy + is enabled for the nodes. + properties: + disabled: + description: Whether NetworkPolicy is enabled for this cluster. + type: boolean + type: object + NodeConfig: + description: Parameters that describe the nodes in a cluster. + properties: + accelerators: + description: A list of hardware accelerators to be attached to each node. + See https://cloud.google.com/compute/docs/gpus for more information about + support for GPUs. + items: + $ref: '#/components/schemas/AcceleratorConfig' + type: array + advancedMachineFeatures: + $ref: '#/components/schemas/AdvancedMachineFeatures' + description: Advanced features for the Compute Engine VM. + bootDiskKmsKey: + description: ' The Customer Managed Encryption Key used to encrypt the boot + disk attached to each node in the node pool. This should be of the form + projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. + For more information about protecting resources with Cloud KMS Keys please + see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption' + type: string + diskSizeGb: + description: Size of the disk attached to each node, specified in GB. The + smallest allowed disk size is 10GB. If unspecified, the default disk size + is 100GB. + format: int32 + type: integer + diskType: + description: Type of the disk attached to each node (e.g. 'pd-standard', + 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' + type: string + gcfsConfig: + $ref: '#/components/schemas/GcfsConfig' + description: Google Container File System (image streaming) configs. + gvnic: + $ref: '#/components/schemas/VirtualNIC' + description: Enable or disable gvnic in the node pool. + imageType: + description: The image type to use for this node. Note that for a given + image type, the latest version of it will be used. + type: string + kubeletConfig: + $ref: '#/components/schemas/NodeKubeletConfig' + description: Node kubelet configs. + labels: + additionalProperties: + type: string + description: 'The map of Kubernetes labels (key/value pairs) to be applied + to each node. These will added in addition to any default label(s) that + Kubernetes may apply to the node. In case of conflict in label keys, the + applied set may differ depending on the Kubernetes version -- it''s best + to assume the behavior is undefined and conflicts should be avoided. For + more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/' + type: object + linuxNodeConfig: + $ref: '#/components/schemas/LinuxNodeConfig' + description: Parameters that can be configured on Linux nodes. + localSsdCount: + description: 'The number of local SSD disks to be attached to the node. + The limit for this value is dependent upon the maximum number of disks + available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd + for more information.' + format: int32 + type: integer + machineType: + description: The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) + If unspecified, the default machine type is `e2-medium`. + type: string + metadata: + additionalProperties: + type: string + description: 'The metadata key/value pairs assigned to instances in the + cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less + than 128 bytes in length. These are reflected as part of a URL in the + metadata server. Additionally, to avoid ambiguity, keys must not conflict + with any other metadata keys for the project or be one of the reserved + keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" + - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" + - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" + - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" + - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" + - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, + and only have meaning as interpreted by the image running in the instance. + The only restriction placed on them is that each value''s size must be + less than or equal to 32 KB. The total size of all keys and values must + be less than 512 KB.' + type: object + minCpuPlatform: + description: 'Minimum CPU platform to be used by this instance. The instance + may be scheduled on the specified or newer CPU platform. Applicable values + are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel + Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, + read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)' + type: string + nodeGroup: + description: Setting this field will assign instances of this pool to run + on the specified node group. This is useful for running workloads on [sole + tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + type: string + oauthScopes: + description: 'The set of Google API scopes to be made available on all of + the node VMs under the "default" service account. The following scopes + are recommended, but not required, and by default are not included: * + `https://www.googleapis.com/auth/compute` is required for mounting persistent + storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` + is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). + If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring + are enabled, in which case their required scopes will be added.' + items: + type: string + type: array + preemptible: + description: 'Whether the nodes are created as preemptible VM instances. + See: https://cloud.google.com/compute/docs/instances/preemptible for more + information about preemptible VM instances.' + type: boolean + reservationAffinity: + $ref: '#/components/schemas/ReservationAffinity' + description: The optional reservation affinity. Setting this field will + apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) + to this node pool. + sandboxConfig: + $ref: '#/components/schemas/SandboxConfig' + description: Sandbox configuration for this node. + serviceAccount: + description: The Google Cloud Platform Service Account to be used by the + node VMs. Specify the email address of the Service Account; otherwise, + if no Service Account is specified, the "default" service account is used. + type: string + shieldedInstanceConfig: + $ref: '#/components/schemas/ShieldedInstanceConfig' + description: Shielded Instance options. + tags: + description: The list of instance tags applied to all nodes. Tags are used + to identify valid sources or targets for network firewalls and are specified + by the client during cluster or node pool creation. Each tag within the + list must comply with RFC1035. + items: + type: string + type: array + taints: + description: 'List of kubernetes taints to be applied to each node. For + more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/' + items: + $ref: '#/components/schemas/NodeTaint' + type: array + workloadMetadataConfig: + $ref: '#/components/schemas/WorkloadMetadataConfig' + description: The workload metadata configuration for this node. + type: object + NodeConfigDefaults: + description: Subset of NodeConfig message that has defaults. + properties: + gcfsConfig: + $ref: '#/components/schemas/GcfsConfig' + description: GCFS (Google Container File System, a.k.a Riptide) options. + type: object + NodeKubeletConfig: + description: Node kubelet configs. + properties: + cpuCfsQuota: + description: Enable CPU CFS quota enforcement for containers that specify + CPU limits. This option is enabled by default which makes kubelet use + CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) + to enforce container CPU limits. Otherwise, CPU limits will not be enforced + at all. Disable this option to mitigate CPU throttling problems while + still having your pods to be in Guaranteed QoS class by specifying the + CPU limits. The default value is 'true' if unspecified. + type: boolean + cpuCfsQuotaPeriod: + description: "Set the CPU CFS quota period value 'cpu.cfs_period_us'. The\ + \ string must be a sequence of decimal numbers, each with optional fraction\ + \ and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"\ + us\" (or \"\xB5s\"), \"ms\", \"s\", \"m\", \"h\". The value must be a\ + \ positive duration." + type: string + cpuManagerPolicy: + description: 'Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ + The following values are allowed. - "none": the default, which represents + the existing scheduling behavior. - "static": allows pods with certain + resource characteristics to be granted increased CPU affinity and exclusivity + on the node. The default value is ''none'' if unspecified.' + type: string + type: object + NodeManagement: + description: NodeManagement defines the set of node management services turned + on for the node pool. + properties: + autoRepair: + description: A flag that specifies whether the node auto-repair is enabled + for the node pool. If enabled, the nodes in this node pool will be monitored + and, if they fail health checks too many times, an automatic repair action + will be triggered. + type: boolean + autoUpgrade: + description: A flag that specifies whether node auto-upgrade is enabled + for the node pool. If enabled, node auto-upgrade helps keep the nodes + in your node pool up to date with the latest release version of Kubernetes. + type: boolean + upgradeOptions: + $ref: '#/components/schemas/AutoUpgradeOptions' + description: Specifies the Auto Upgrade knobs for the node pool. + type: object + NodeNetworkConfig: + description: Parameters for node pool-level network config. + properties: + createPodRange: + description: Input only. Whether to create a new range for pod IPs in this + node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` + if they are not specified. If neither `create_pod_range` or `pod_range` + are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) + is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. + This field cannot be changed after the node pool has been created. + type: boolean + podIpv4CidrBlock: + description: 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. + type: string + podRange: + description: 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. + type: string + type: object + NodePool: + description: NodePool contains the name and configuration for a cluster's node + pool. Node pools are a set of nodes (i.e. VM's), with a common configuration + and specification, under the control of the cluster master. They may have + a set of Kubernetes labels applied to them, which may be used to reference + them during pod scheduling. They may also be resized up or down, to accommodate + the workload. + properties: + autoscaling: + $ref: '#/components/schemas/NodePoolAutoscaling' + description: Autoscaler configuration for this NodePool. Autoscaler is enabled + only if a valid configuration is present. + conditions: + description: Which conditions caused the current node pool state. + items: + $ref: '#/components/schemas/StatusCondition' + type: array + config: + $ref: '#/components/schemas/NodeConfig' + description: The node configuration of the pool. + initialNodeCount: + description: The initial node count for the pool. You must ensure that your + Compute Engine [resource quota](https://cloud.google.com/compute/quotas) + is sufficient for this number of instances. You must also have available + firewall and routes quota. + format: int32 + type: integer + instanceGroupUrls: + description: '[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) + associated with this node pool.' + items: + type: string + type: array + locations: + description: 'The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) + in which the NodePool''s nodes should be located. If this value is unspecified + during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) + value will be used, instead. Warning: changing node pool locations will + result in nodes being added and/or removed.' + items: + type: string + type: array + management: + $ref: '#/components/schemas/NodeManagement' + description: NodeManagement configuration for this NodePool. + maxPodsConstraint: + $ref: '#/components/schemas/MaxPodsConstraint' + description: The constraint on the maximum number of pods that can be run + simultaneously on a node in the node pool. + name: + description: The name of the node pool. + type: string + networkConfig: + $ref: '#/components/schemas/NodeNetworkConfig' + description: Networking configuration for this NodePool. If specified, it + overrides the cluster-level defaults. + podIpv4CidrSize: + description: '[Output only] The pod CIDR block size per node in this node + pool.' + format: int32 + type: integer + selfLink: + description: '[Output only] Server-defined URL for the resource.' + type: string + status: + description: '[Output only] The status of the nodes in this pool instance.' + enum: + - STATUS_UNSPECIFIED + - PROVISIONING + - RUNNING + - RUNNING_WITH_ERROR + - RECONCILING + - STOPPING + - ERROR + type: string + statusMessage: + description: '[Output only] Deprecated. Use conditions instead. Additional + information about the current status of this node pool instance, if available.' + type: string + upgradeSettings: + $ref: '#/components/schemas/UpgradeSettings' + description: Upgrade settings control disruption and speed of the upgrade. + version: + description: The version of the Kubernetes of this node. + type: string + type: object + NodePoolAutoscaling: + description: NodePoolAutoscaling contains information required by cluster autoscaler + to adjust the size of the node pool to the current cluster usage. + properties: + autoprovisioned: + description: Can this node pool be deleted automatically. + type: boolean + enabled: + description: Is autoscaling enabled for this node pool. + type: boolean + maxNodeCount: + description: Maximum number of nodes for one location in the NodePool. Must + be >= min_node_count. There has to be enough quota to scale up the cluster. + format: int32 + type: integer + minNodeCount: + description: Minimum number of nodes for one location in the NodePool. Must + be >= 1 and <= max_node_count. + format: int32 + type: integer + type: object + NodePoolDefaults: + description: Subset of Nodepool message that has defaults. + properties: + nodeConfigDefaults: + $ref: '#/components/schemas/NodeConfigDefaults' + description: Subset of NodeConfig message that has defaults. + type: object + NodeTaint: + description: 'Kubernetes taint is comprised of three fields: key, value, and + effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule + or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) + for more information, including usage and the valid values.' + properties: + effect: + description: Effect for taint. + enum: + - EFFECT_UNSPECIFIED + - NO_SCHEDULE + - PREFER_NO_SCHEDULE + - NO_EXECUTE + type: string + key: + description: Key for taint. + type: string + value: + description: Value for taint. + type: string + type: object + NotificationConfig: + description: NotificationConfig is the configuration of notifications. + properties: + pubsub: + $ref: '#/components/schemas/PubSub' + description: Notification config for Pub/Sub. + type: object + Operation: + description: This operation resource represents operations that may have happened + or are happening on the cluster. All fields are output only. + properties: + clusterConditions: + description: Which conditions caused the current cluster state. Deprecated. + Use field error instead. + items: + $ref: '#/components/schemas/StatusCondition' + type: array + detail: + description: Detailed operation progress, if available. + type: string + endTime: + description: '[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) + text format.' + type: string + error: + $ref: '#/components/schemas/Status' + description: The error result of the operation in case of failure. + location: + description: '[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) + or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) + in which the cluster resides.' + type: string + name: + description: The server-assigned ID for the operation. + type: string + nodepoolConditions: + description: Which conditions caused the current node pool state. Deprecated. + Use field error instead. + items: + $ref: '#/components/schemas/StatusCondition' + type: array + operationType: + description: The operation type. + enum: + - TYPE_UNSPECIFIED + - CREATE_CLUSTER + - DELETE_CLUSTER + - UPGRADE_MASTER + - UPGRADE_NODES + - REPAIR_CLUSTER + - UPDATE_CLUSTER + - CREATE_NODE_POOL + - DELETE_NODE_POOL + - SET_NODE_POOL_MANAGEMENT + - AUTO_REPAIR_NODES + - AUTO_UPGRADE_NODES + - SET_LABELS + - SET_MASTER_AUTH + - SET_NODE_POOL_SIZE + - SET_NETWORK_POLICY + - SET_MAINTENANCE_POLICY + type: string + progress: + $ref: '#/components/schemas/OperationProgress' + description: Output only. [Output only] Progress information for an operation. + readOnly: true + selfLink: + description: Server-defined URL for the resource. + type: string + startTime: + description: '[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) + text format.' + type: string + status: + description: The current status of the operation. + enum: + - STATUS_UNSPECIFIED + - PENDING + - RUNNING + - DONE + - ABORTING + type: string + statusMessage: + description: Output only. If an error has occurred, a textual description + of the error. Deprecated. Use the field error instead. + readOnly: true + type: string + targetLink: + description: Server-defined URL for the target of the operation. + type: string + zone: + description: The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the operation is taking place. This field is deprecated, use + location instead. + type: string + type: object + OperationProgress: + description: Information about operation (or operation stage) progress. + properties: + metrics: + description: 'Progress metric bundle, for example: metrics: [{name: "nodes + done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: + [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: + 1.0}]' + items: + $ref: '#/components/schemas/Metric' + type: array + name: + description: A non-parameterized string describing an operation stage. Unset + for single-stage operations. + type: string + stages: + description: Substages of an operation or a stage. + items: + $ref: '#/components/schemas/OperationProgress' + type: array + status: + description: Status of an operation stage. Unset for single-stage operations. + enum: + - STATUS_UNSPECIFIED + - PENDING + - RUNNING + - DONE + - ABORTING + type: string + type: object + PrivateClusterConfig: + description: Configuration options for private clusters. + properties: + enablePrivateEndpoint: + description: Whether the master's internal IP address is used as the cluster + endpoint. + type: boolean + enablePrivateNodes: + description: Whether nodes have internal IP addresses only. If enabled, + all nodes are given only RFC 1918 private addresses and communicate with + the master via private networking. + type: boolean + masterGlobalAccessConfig: + $ref: '#/components/schemas/PrivateClusterMasterGlobalAccessConfig' + description: Controls master global access settings. + masterIpv4CidrBlock: + description: The IP range in CIDR notation to use for the hosted master + network. This range will be used for assigning internal IP addresses to + the master or set of masters, as well as the ILB VIP. This range must + not overlap with any other ranges in use within the cluster's network. + type: string + peeringName: + description: Output only. The peering name in the customer VPC used by this + cluster. + type: string + privateEndpoint: + description: Output only. The internal IP address of this cluster's master + endpoint. + type: string + publicEndpoint: + description: Output only. The external IP address of this cluster's master + endpoint. + type: string + type: object + PrivateClusterMasterGlobalAccessConfig: + description: Configuration for controlling master global access settings. + properties: + enabled: + description: Whenever master is accessible globally or not. + type: boolean + type: object + PubSub: + description: Pub/Sub specific notification config. + properties: + enabled: + description: Enable notifications for Pub/Sub. + type: boolean + topic: + description: The desired Pub/Sub topic to which notifications will be sent + by GKE. Format is `projects/{project}/topics/{topic}`. + type: string + type: object + RecurringTimeWindow: + description: Represents an arbitrary window of time that recurs. + properties: + recurrence: + description: 'An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) + for how this window reccurs. They go on for the span of time between the + start and end time. For example, to have something repeat every weekday, + you''d use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily + (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first + weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies + how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 + window every weekday, you''d use something like: ``` start time = 2019-01-01T09:00:00-0400 + end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR + ``` Windows can span multiple days. Eg, to make the window encompass every + weekend from midnight Saturday till the last minute of Sunday UTC: ``` + start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence + = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time''s specific dates + are largely arbitrary except to specify duration of the window and when + it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are + not supported.' + type: string + window: + $ref: '#/components/schemas/TimeWindow' + description: The window of the first recurrence. + type: object + ReleaseChannel: + description: ReleaseChannel indicates which release channel a cluster is subscribed + to. Release channels are arranged in order of risk. When a cluster is subscribed + to a release channel, Google maintains both the master version and the node + version. Node auto-upgrade defaults to true and cannot be disabled. + properties: + channel: + description: channel specifies which release channel the cluster is subscribed + to. + enum: + - UNSPECIFIED + - RAPID + - REGULAR + - STABLE + type: string + type: object + ReleaseChannelConfig: + description: ReleaseChannelConfig exposes configuration for a release channel. + properties: + channel: + description: The release channel this configuration applies to. + enum: + - UNSPECIFIED + - RAPID + - REGULAR + - STABLE + type: string + defaultVersion: + description: The default version for newly created clusters on the channel. + type: string + validVersions: + description: List of valid versions for the channel. + items: + type: string + type: array + type: object + ReservationAffinity: + description: '[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) + is the configuration of desired reservation which instances could take capacity + from.' + properties: + consumeReservationType: + description: Corresponds to the type of reservation consumption. + enum: + - UNSPECIFIED + - NO_RESERVATION + - ANY_RESERVATION + - SPECIFIC_RESERVATION + type: string + key: + description: Corresponds to the label key of a reservation resource. To + target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" + as the key and specify the name of your reservation as its value. + type: string + values: + description: Corresponds to the label value(s) of reservation resource(s). + items: + type: string + type: array + type: object + ResourceLimit: + description: Contains information about amount of some resource in the cluster. + For memory, value should be in GB. + properties: + maximum: + description: Maximum amount of the resource in the cluster. + format: int64 + type: string + minimum: + description: Minimum amount of the resource in the cluster. + format: int64 + type: string + resourceType: + description: Resource name "cpu", "memory" or gpu-specific string. + type: string + type: object + ResourceUsageExportConfig: + description: Configuration for exporting cluster resource usages. + properties: + bigqueryDestination: + $ref: '#/components/schemas/BigQueryDestination' + description: Configuration to use BigQuery as usage export destination. + consumptionMeteringConfig: + $ref: '#/components/schemas/ConsumptionMeteringConfig' + description: Configuration to enable resource consumption metering. + enableNetworkEgressMetering: + description: Whether to enable network egress metering for this cluster. + If enabled, a daemonset will be created in the cluster to meter network + egress traffic. + type: boolean + type: object + RollbackNodePoolUpgradeRequest: + description: RollbackNodePoolUpgradeRequest rollbacks the previously Aborted + or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully + completed. + properties: + clusterId: + description: Deprecated. The name of the cluster to rollback. This field + has been deprecated and replaced by the name field. + type: string + name: + description: The name (project, location, cluster, node pool id) of the + node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + type: string + nodePoolId: + description: Deprecated. The name of the node pool to rollback. This field + has been deprecated and replaced by the name field. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SandboxConfig: + description: SandboxConfig contains configurations of the sandbox to use for + the node. + properties: + type: + description: Type of the sandbox to use for the node. + enum: + - UNSPECIFIED + - GVISOR + type: string + type: object + ServerConfig: + description: Kubernetes Engine service configuration. + properties: + channels: + description: List of release channel configurations. + items: + $ref: '#/components/schemas/ReleaseChannelConfig' + type: array + defaultClusterVersion: + description: Version of Kubernetes the service deploys by default. + type: string + defaultImageType: + description: Default image type. + type: string + validImageTypes: + description: List of valid image types. + items: + type: string + type: array + validMasterVersions: + description: List of valid master versions, in descending order. + items: + type: string + type: array + validNodeVersions: + description: List of valid node upgrade target versions, in descending order. + items: + type: string + type: array + type: object + SetAddonsConfigRequest: + description: SetAddonsConfigRequest sets the addons associated with the cluster. + properties: + addonsConfig: + $ref: '#/components/schemas/AddonsConfig' + description: Required. The desired configurations for the various addons + available to run in the cluster. + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + name: + description: The name (project, location, cluster) of the cluster to set + addons. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetLabelsRequest: + description: SetLabelsRequest sets the Google Cloud Platform labels on a Google + Container Engine cluster, which will in turn set them for Google Compute Engine + resources used by that cluster + properties: + clusterId: + description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + type: string + labelFingerprint: + description: Required. The fingerprint of the previous set of labels for + this resource, used to detect conflicts. The fingerprint is initially + generated by Kubernetes Engine and changes after every request to modify + or update labels. You must always provide an up-to-date fingerprint hash + when updating or changing labels. Make a `get()` request to the resource + to get the latest fingerprint. + type: string + name: + description: The name (project, location, cluster id) of the cluster to + set labels. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + type: string + resourceLabels: + additionalProperties: + type: string + description: Required. The labels to set for that cluster. + type: object + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetLegacyAbacRequest: + description: SetLegacyAbacRequest enables or disables the ABAC authorization + mechanism for a cluster. + properties: + clusterId: + description: Deprecated. The name of the cluster to update. This field has + been deprecated and replaced by the name field. + type: string + enabled: + description: Required. Whether ABAC authorization will be enabled in the + cluster. + type: boolean + name: + description: The name (project, location, cluster id) of the cluster to + set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetLocationsRequest: + description: SetLocationsRequest sets the locations of the cluster. + properties: + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + locations: + description: Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) + in which the cluster's nodes should be located. Changing the locations + a cluster is in will result in nodes being either created or removed from + the cluster, depending on whether locations are being added or removed. + This list must always include the cluster's primary zone. + items: + type: string + type: array + name: + description: The name (project, location, cluster) of the cluster to set + locations. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetLoggingServiceRequest: + description: SetLoggingServiceRequest sets the logging service of a cluster. + properties: + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + loggingService: + description: 'Required. The logging service the cluster should use to write + logs. Currently available options: * `logging.googleapis.com/kubernetes` + - The Cloud Logging service with a Kubernetes-native resource model * + `logging.googleapis.com` - The legacy Cloud Logging service (no longer + available as of GKE 1.15). * `none` - no logs will be exported from the + cluster. If left as an empty string,`logging.googleapis.com/kubernetes` + will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.' + type: string + name: + description: The name (project, location, cluster) of the cluster to set + logging. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetMaintenancePolicyRequest: + description: SetMaintenancePolicyRequest sets the maintenance policy for a cluster. + properties: + clusterId: + description: Required. The name of the cluster to update. + type: string + maintenancePolicy: + $ref: '#/components/schemas/MaintenancePolicy' + description: Required. The maintenance policy to be set for the cluster. + An empty field clears the existing maintenance policy. + name: + description: The name (project, location, cluster id) of the cluster to + set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Required. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). + type: string + zone: + description: Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. + type: string + type: object + SetMasterAuthRequest: + description: SetMasterAuthRequest updates the admin password of a cluster. + properties: + action: + description: Required. The exact form of action to be taken on the master + auth. + enum: + - UNKNOWN + - SET_PASSWORD + - GENERATE_PASSWORD + - SET_USERNAME + type: string + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + name: + description: The name (project, location, cluster) of the cluster to set + auth. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + update: + $ref: '#/components/schemas/MasterAuth' + description: Required. A description of the update. + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetMonitoringServiceRequest: + description: SetMonitoringServiceRequest sets the monitoring service of a cluster. + properties: + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + monitoringService: + description: 'Required. The monitoring service the cluster should use to + write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" + - The Cloud Monitoring service with a Kubernetes-native resource model + * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + longer available as of GKE 1.15). * `none` - No metrics will be exported + from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` + will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier + versions.' + type: string + name: + description: The name (project, location, cluster) of the cluster to set + monitoring. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetNetworkPolicyRequest: + description: SetNetworkPolicyRequest enables/disables network policy for a cluster. + properties: + clusterId: + description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + type: string + name: + description: The name (project, location, cluster id) of the cluster to + set networking policy. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + networkPolicy: + $ref: '#/components/schemas/NetworkPolicy' + description: Required. Configuration options for the NetworkPolicy feature. + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetNodePoolAutoscalingRequest: + description: SetNodePoolAutoscalingRequest sets the autoscaler settings of a + node pool. + properties: + autoscaling: + $ref: '#/components/schemas/NodePoolAutoscaling' + description: Required. Autoscaling configuration for the node pool. + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + name: + description: The name (project, location, cluster, node pool) of the node + pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + type: string + nodePoolId: + description: Deprecated. The name of the node pool to upgrade. This field + has been deprecated and replaced by the name field. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetNodePoolManagementRequest: + description: SetNodePoolManagementRequest sets the node management properties + of a node pool. + properties: + clusterId: + description: Deprecated. The name of the cluster to update. This field has + been deprecated and replaced by the name field. + type: string + management: + $ref: '#/components/schemas/NodeManagement' + description: Required. NodeManagement configuration for the node pool. + name: + description: The name (project, location, cluster, node pool id) of the + node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + type: string + nodePoolId: + description: Deprecated. The name of the node pool to update. This field + has been deprecated and replaced by the name field. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + SetNodePoolSizeRequest: + description: SetNodePoolSizeRequest sets the size of a node pool. + properties: + clusterId: + description: Deprecated. The name of the cluster to update. This field has + been deprecated and replaced by the name field. + type: string + name: + description: The name (project, location, cluster, node pool id) of the + node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + type: string + nodeCount: + description: Required. The desired node count for the pool. + format: int32 + type: integer + nodePoolId: + description: Deprecated. The name of the node pool to update. This field + has been deprecated and replaced by the name field. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + ShieldedInstanceConfig: + description: A set of Shielded Instance options. + properties: + enableIntegrityMonitoring: + description: Defines whether the instance has integrity monitoring enabled. + Enables monitoring and attestation of the boot integrity of the instance. + The attestation is performed against the integrity policy baseline. This + baseline is initially derived from the implicitly trusted boot image when + the instance is created. + type: boolean + enableSecureBoot: + description: Defines whether the instance has Secure Boot enabled. Secure + Boot helps ensure that the system only runs authentic software by verifying + the digital signature of all boot components, and halting the boot process + if signature verification fails. + type: boolean + type: object + ShieldedNodes: + description: Configuration of Shielded Nodes feature. + properties: + enabled: + description: Whether Shielded Nodes features are enabled on all nodes in + this cluster. + type: boolean + type: object + StartIPRotationRequest: + description: StartIPRotationRequest creates a new IP for the cluster and then + performs a node upgrade on each node pool to point to the new IP. + properties: + clusterId: + description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + type: string + name: + description: The name (project, location, cluster id) of the cluster to + start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + type: string + rotateCredentials: + description: Whether to rotate credentials during IP rotation. + type: boolean + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + Status: + description: '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).' + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + details: + description: A list of messages that carry the error details. There is a + common set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type + URL. + type: object + type: array + message: + description: 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. + type: string + type: object + StatusCondition: + description: StatusCondition describes why a cluster or a node pool has a certain + status (e.g., ERROR or DEGRADED). + properties: + canonicalCode: + description: Canonical code of the condition. + enum: + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS + type: string + code: + description: Machine-friendly representation of the condition Deprecated. + Use canonical_code instead. + enum: + - UNKNOWN + - GCE_STOCKOUT + - GKE_SERVICE_ACCOUNT_DELETED + - GCE_QUOTA_EXCEEDED + - SET_BY_OPERATOR + - CLOUD_KMS_KEY_ERROR + - CA_EXPIRING + type: string + message: + description: Human-friendly representation of the condition + type: string + type: object + TimeWindow: + description: Represents an arbitrary window of time. + properties: + endTime: + description: The time that the window ends. The end time should take place + after the start time. + format: google-datetime + type: string + startTime: + description: The time that the window first starts. + format: google-datetime + type: string + type: object + UpdateClusterRequest: + description: UpdateClusterRequest updates the settings of a cluster. + properties: + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + name: + description: The name (project, location, cluster) of the cluster to update. + Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + update: + $ref: '#/components/schemas/ClusterUpdate' + description: Required. A description of the update. + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + UpdateMasterRequest: + description: UpdateMasterRequest updates the master of the cluster. + properties: + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + masterVersion: + description: 'Required. The Kubernetes version to change the master to. + Users may specify either explicit versions offered by Kubernetes Engine + or version aliases, which have the following behavior: - "latest": picks + the highest valid Kubernetes version - "1.X": picks the highest valid + patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid + gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes + version - "-": picks the default Kubernetes version' + type: string + name: + description: The name (project, location, cluster) of the cluster to update. + Specified in the format `projects/*/locations/*/clusters/*`. + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + UpdateNodePoolRequest: + description: UpdateNodePoolRequests update a node pool's image and/or version. + properties: + clusterId: + description: Deprecated. The name of the cluster to upgrade. This field + has been deprecated and replaced by the name field. + type: string + gcfsConfig: + $ref: '#/components/schemas/GcfsConfig' + description: GCFS config. + gvnic: + $ref: '#/components/schemas/VirtualNIC' + description: Enable or disable gvnic on the node pool. + imageType: + description: Required. The desired image type for the node pool. + type: string + kubeletConfig: + $ref: '#/components/schemas/NodeKubeletConfig' + description: Node kubelet configs. + linuxNodeConfig: + $ref: '#/components/schemas/LinuxNodeConfig' + description: Parameters that can be configured on Linux nodes. + locations: + description: The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) + in which the node pool's nodes should be located. Changing the locations + for a node pool will result in nodes being either created or removed from + the node pool, depending on whether locations are being added or removed. + items: + type: string + type: array + name: + description: The name (project, location, cluster, node pool) of the node + pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + type: string + nodePoolId: + description: Deprecated. The name of the node pool to upgrade. This field + has been deprecated and replaced by the name field. + type: string + nodeVersion: + description: 'Required. The Kubernetes version to change the nodes to (typically + an upgrade). Users may specify either explicit versions offered by Kubernetes + Engine or version aliases, which have the following behavior: - "latest": + picks the highest valid Kubernetes version - "1.X": picks the highest + valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest + valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit + Kubernetes version - "-": picks the Kubernetes master version' + type: string + projectId: + description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + type: string + upgradeSettings: + $ref: '#/components/schemas/UpgradeSettings' + description: Upgrade settings control disruption and speed of the upgrade. + workloadMetadataConfig: + $ref: '#/components/schemas/WorkloadMetadataConfig' + description: The desired workload metadata config for the node pool. + zone: + description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + type: string + type: object + UpgradeAvailableEvent: + description: UpgradeAvailableEvent is a notification sent to customers when + a new available version is released. + properties: + releaseChannel: + $ref: '#/components/schemas/ReleaseChannel' + description: The release channel of the version. If empty, it means a non-channel + release. + resource: + description: Optional relative path to the resource. For example, the relative + path of the node pool. + type: string + resourceType: + description: The resource type of the release version. + enum: + - UPGRADE_RESOURCE_TYPE_UNSPECIFIED + - MASTER + - NODE_POOL + type: string + version: + description: The release version available for upgrade. + type: string + type: object + UpgradeEvent: + description: UpgradeEvent is a notification sent to customers by the cluster + server when a resource is upgrading. + properties: + currentVersion: + description: The current version before the upgrade. + type: string + operation: + description: The operation associated with this upgrade. + type: string + operationStartTime: + description: The time when the operation was started. + format: google-datetime + type: string + resource: + description: Optional relative path to the resource. For example in node + pool upgrades, the relative path of the node pool. + type: string + resourceType: + description: The resource type that is upgrading. + enum: + - UPGRADE_RESOURCE_TYPE_UNSPECIFIED + - MASTER + - NODE_POOL + type: string + targetVersion: + description: The target version for the upgrade. + type: string + type: object + UpgradeSettings: + description: 'These upgrade settings control the level of parallelism and the + level of disruption caused by an upgrade. maxUnavailable controls the number + of nodes that can be simultaneously unavailable. maxSurge controls the number + of additional nodes that can be added to the node pool temporarily for the + time of the upgrade to increase the number of available nodes. (maxUnavailable + + maxSurge) determines the level of parallelism (how many nodes are being + upgraded at the same time). Note: upgrades inevitably introduce some disruption + since workloads need to be moved from old nodes to new, upgraded ones. Even + if maxUnavailable=0, this holds true. (Disruption stays within the limits + of PodDisruptionBudget, if it is configured.) Consider a hypothetical node + pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade + process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) + nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. + This ensures that there are always at least 4 nodes available.' + properties: + maxSurge: + description: The maximum number of nodes that can be created beyond the + current size of the node pool during the upgrade process. + format: int32 + type: integer + maxUnavailable: + description: The maximum number of nodes that can be simultaneously unavailable + during the upgrade process. A node is considered available if its status + is Ready. + format: int32 + type: integer + type: object + UsableSubnetwork: + description: UsableSubnetwork resource returns the subnetwork name, its associated + network and the primary CIDR range. + properties: + ipCidrRange: + description: The range of internal addresses that are owned by this subnetwork. + type: string + network: + description: 'Network Name. Example: projects/my-project/global/networks/my-network' + type: string + secondaryIpRanges: + description: Secondary IP ranges. + items: + $ref: '#/components/schemas/UsableSubnetworkSecondaryRange' + type: array + statusMessage: + description: A human readable status message representing the reasons for + cases where the caller cannot use the secondary ranges under the subnet. + For example if the secondary_ip_ranges is empty due to a permission issue, + an insufficient permission message will be given by status_message. + type: string + subnetwork: + description: 'Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet' + type: string + type: object + UsableSubnetworkSecondaryRange: + description: Secondary IP range of a usable subnetwork. + properties: + ipCidrRange: + description: The range of IP addresses belonging to this subnetwork secondary + range. + type: string + rangeName: + description: The name associated with this subnetwork secondary range, used + when adding an alias IP range to a VM instance. + type: string + status: + description: This field is to determine the status of the secondary range + programmably. + enum: + - UNKNOWN + - UNUSED + - IN_USE_SERVICE + - IN_USE_SHAREABLE_POD + - IN_USE_MANAGED_POD + type: string + type: object + VerticalPodAutoscaling: + description: VerticalPodAutoscaling contains global, per-cluster information + required by Vertical Pod Autoscaler to automatically adjust the resources + of pods controlled by it. + properties: + enabled: + description: Enables vertical pod autoscaling. + type: boolean + type: object + VirtualNIC: + description: Configuration of gVNIC feature. + properties: + enabled: + description: Whether gVNIC features are enabled in the node pool. + type: boolean + type: object + WorkloadIdentityConfig: + description: Configuration for the use of Kubernetes Service Accounts in GCP + IAM policies. + properties: + workloadPool: + description: The workload pool to attach all Kubernetes service accounts + to. + type: string + type: object + WorkloadMetadataConfig: + description: WorkloadMetadataConfig defines the metadata configuration to expose + to workloads on the node pool. + properties: + mode: + description: Mode is the configuration for how to expose metadata to workloads + running on the node pool. + enum: + - MODE_UNSPECIFIED + - GCE_METADATA + - GKE_METADATA + type: string + type: object + securitySchemes: + Oauth2: + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + type: oauth2 + Oauth2c: + description: Oauth 2.0 authorizationCode authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: See, edit, configure, + and delete your Google Cloud data and see the email address for your + Google Account. + tokenUrl: https://accounts.google.com/o/oauth2/token + type: oauth2 + x-stackQL-resources: + projects.aggregated.usableSubnetworks: + id: google.container.projects.aggregated.usableSubnetworks + methods: + list: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/aggregated/usableSubnetworks + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.aggregated.usableSubnetworks + title: projects.aggregated.usableSubnetworks + projects.locations: + id: google.container.projects.locations + methods: + getServerConfig: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/serverConfig + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.locations + title: projects.locations + projects.locations.clusters: + id: google.container.projects.locations.clusters + methods: + completeIpRotation: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} + response: + mediaType: application/json + openAPIDocKey: '200' + getJwks: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/jwks + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters + response: + mediaType: application/json + openAPIDocKey: '200' + setAddons: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLegacyAbac: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLocations: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setLogging: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMaintenancePolicy: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMasterAuth: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMonitoring: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setNetworkPolicy: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setResourceLabels: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + startIpRotation: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + updateMaster: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.locations.clusters + title: projects.locations.clusters + projects.locations.clusters.nodePools: + id: google.container.projects.locations.clusters.nodePools + methods: + create: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools + response: + mediaType: application/json + openAPIDocKey: '200' + rollback: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setAutoscaling: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setManagement: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSize: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setSize + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.locations.clusters.nodePools + title: projects.locations.clusters.nodePools + projects.locations.clusters.well-known: + id: google.container.projects.locations.clusters.well-known + methods: + getOpenid-configuration: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.locations.clusters.well-known + title: projects.locations.clusters.well-known + projects.locations.operations: + id: google.container.projects.locations.operations + methods: + cancel: + operation: + $ref: post + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v1/projects/{projectsId}/locations/{locationsId}/operations + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.locations.operations + title: projects.locations.operations + projects.zones: + id: google.container.projects.zones + methods: + getServerconfig: + operation: + $ref: get + path: + $ref: /v1/projects/{projectId}/zones/{zone}/serverconfig + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.zones + title: projects.zones + projects.zones.clusters: + id: google.container.projects.zones.clusters + methods: + addons: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + completeIpRotation: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId} + response: + mediaType: application/json + openAPIDocKey: '200' + legacyAbac: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters + response: + mediaType: application/json + openAPIDocKey: '200' + locations: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + logging: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + master: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + monitoring: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + resourceLabels: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMaintenancePolicy: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setMasterAuth: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setNetworkPolicy: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + startIpRotation: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.zones.clusters + title: projects.zones.clusters + projects.zones.clusters.nodePools: + id: google.container.projects.zones.clusters.nodePools + methods: + autoscaling: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId} + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools + response: + mediaType: application/json + openAPIDocKey: '200' + rollback: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setManagement: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setSize: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.zones.clusters.nodePools + title: projects.zones.clusters.nodePools + projects.zones.operations: + id: google.container.projects.zones.operations + methods: + cancel: + operation: + $ref: post + path: + $ref: /v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /v1/projects/{projectId}/zones/{zone}/operations/{operationId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /v1/projects/{projectId}/zones/{zone}/operations + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.zones.operations + title: projects.zones.operations +externalDocs: + url: https://cloud.google.com/container-engine/ +info: + contact: + name: Google + url: https://google.com + x-twitter: youtube + description: Builds and manages container-based applications, powered by the open + source Kubernetes technology. + license: + name: Creative Commons Attribution 3.0 + url: http://creativecommons.org/licenses/by/3.0/ + termsOfService: https://developers.google.com/terms/ + title: Kubernetes Engine API + version: v1 + x-apiClientRegistration: + url: https://console.developers.google.com + x-apisguru-categories: + - analytics + - media + x-logo: + url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png + x-origin: + - format: google + url: https://container.googleapis.com/$discovery/rest?version=v1 + version: v1 + x-preferred: false + x-providerName: googleapis.com + x-serviceName: container +openapi: 3.0.0 +paths: + /v1/projects/{projectId}/zones/{zone}/clusters: + get: + description: Lists all clusters owned by a project in either the specified zone + or all zones. + operationId: container.projects.zones.clusters.list + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the parent field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides, or "-" for all zones. This field has been + deprecated and replaced by the parent field. + in: path + name: zone + required: true + schema: + type: string + - description: The parent (project and location) where the clusters will be + listed. Specified in the format `projects/*/locations/*`. Location "-" matches + all zones and all regions. + in: query + name: parent + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListClustersResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a cluster, consisting of the specified number and type + of Google Compute Engine instances. By default, the cluster is created in + the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + One firewall is added for the cluster. After cluster creation, the Kubelet + creates routes for each node to allow the containers on that node to communicate + with all other instances in the cluster. Finally, an entry is added to the + project's global metadata indicating which CIDR range the cluster is using. + operationId: container.projects.zones.clusters.create + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the parent field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the parent field. + in: path + name: zone + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}: + delete: + description: Deletes the cluster, including the Kubernetes endpoint and all + worker nodes. Firewalls and routes that were configured during cluster creation + are also deleted. Other Google Compute Engine resources that might be in use + by the cluster, such as load balancer resources, are not deleted if they weren't + present when the cluster was initially created. + operationId: container.projects.zones.clusters.delete + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to delete. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: The name (project, location, cluster) of the cluster to delete. + Specified in the format `projects/*/locations/*/clusters/*`. + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + get: + description: Gets the details of a specific cluster. + operationId: container.projects.zones.clusters.get + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to retrieve. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: The name (project, location, cluster) of the cluster to retrieve. + Specified in the format `projects/*/locations/*/clusters/*`. + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + put: + description: Updates the settings of a specific cluster. + operationId: container.projects.zones.clusters.update + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateClusterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the addons for a specific cluster. + operationId: container.projects.zones.clusters.addons + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetAddonsConfigRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Enables or disables the ABAC authorization mechanism on a cluster. + operationId: container.projects.zones.clusters.legacyAbac + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to update. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLegacyAbacRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) + instead. + operationId: container.projects.zones.clusters.locations + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLocationsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the logging service for a specific cluster. + operationId: container.projects.zones.clusters.logging + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLoggingServiceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Updates the master for a specific cluster. + operationId: container.projects.zones.clusters.master + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMasterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the monitoring service for a specific cluster. + operationId: container.projects.zones.clusters.monitoring + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMonitoringServiceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools: + get: + description: Lists the node pools for a cluster. + operationId: container.projects.zones.clusters.nodePools.list + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the parent field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the parent field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the parent field. + in: path + name: clusterId + required: true + schema: + type: string + - description: The parent (project, location, cluster id) where the node pools + will be listed. Specified in the format `projects/*/locations/*/clusters/*`. + in: query + name: parent + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListNodePoolsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a node pool for a cluster. + operationId: container.projects.zones.clusters.nodePools.create + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the parent field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the parent field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the parent field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNodePoolRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}: + delete: + description: Deletes a node pool from a cluster. + operationId: container.projects.zones.clusters.nodePools.delete + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: Deprecated. The name of the node pool to delete. This field has + been deprecated and replaced by the name field. + in: path + name: nodePoolId + required: true + schema: + type: string + - description: The name (project, location, cluster, node pool id) of the node + pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + get: + description: Retrieves the requested node pool. + operationId: container.projects.zones.clusters.nodePools.get + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: Deprecated. The name of the node pool. This field has been deprecated + and replaced by the name field. + in: path + name: nodePoolId + required: true + schema: + type: string + - description: The name (project, location, cluster, node pool id) of the node + pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodePool' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the autoscaling settings for the specified node pool. + operationId: container.projects.zones.clusters.nodePools.autoscaling + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: Deprecated. The name of the node pool to upgrade. This field + has been deprecated and replaced by the name field. + in: path + name: nodePoolId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolAutoscalingRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the NodeManagement options for a node pool. + operationId: container.projects.zones.clusters.nodePools.setManagement + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to update. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: Deprecated. The name of the node pool to update. This field has + been deprecated and replaced by the name field. + in: path + name: nodePoolId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolManagementRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the size for a specific node pool. The new size will be used + for all replicas, including future replicas created by modifying NodePool.locations. + operationId: container.projects.zones.clusters.nodePools.setSize + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to update. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: Deprecated. The name of the node pool to update. This field has + been deprecated and replaced by the name field. + in: path + name: nodePoolId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolSizeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Updates the version and/or image type for the specified node pool. + operationId: container.projects.zones.clusters.nodePools.update + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: Deprecated. The name of the node pool to upgrade. This field + has been deprecated and replaced by the name field. + in: path + name: nodePoolId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNodePoolRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Rolls back a previously Aborted or Failed NodePool upgrade. This + makes no changes if the last upgrade successfully completed. + operationId: container.projects.zones.clusters.nodePools.rollback + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to rollback. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + - description: Deprecated. The name of the node pool to rollback. This field + has been deprecated and replaced by the name field. + in: path + name: nodePoolId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RollbackNodePoolUpgradeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets labels on a cluster. + operationId: container.projects.zones.clusters.resourceLabels + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Completes master IP rotation. + operationId: container.projects.zones.clusters.completeIpRotation + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompleteIPRotationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the maintenance policy for a cluster. + operationId: container.projects.zones.clusters.setMaintenancePolicy + parameters: + - description: Required. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). + in: path + name: projectId + required: true + schema: + type: string + - description: Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. + in: path + name: zone + required: true + schema: + type: string + - description: Required. The name of the cluster to update. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMaintenancePolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets master auth materials. Currently supports changing the admin + password or a specific cluster, either via password generation or explicitly + setting the password. + operationId: container.projects.zones.clusters.setMasterAuth + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster to upgrade. This field has + been deprecated and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMasterAuthRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Enables or disables Network Policy for a cluster. + operationId: container.projects.zones.clusters.setNetworkPolicy + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNetworkPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Starts master IP rotation. + operationId: container.projects.zones.clusters.startIpRotation + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: path + name: clusterId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartIPRotationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/operations: + get: + description: Lists all operations in a project in a specific zone or all zones. + operationId: container.projects.zones.operations.list + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the parent field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + to return operations for, or `-` for all zones. This field has been deprecated + and replaced by the parent field. + in: path + name: zone + required: true + schema: + type: string + - description: The parent (project and location) where the operations will be + listed. Specified in the format `projects/*/locations/*`. Location "-" matches + all zones and all regions. + in: query + name: parent + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectId}/zones/{zone}/operations/{operationId}: + get: + description: Gets the specified operation. + operationId: container.projects.zones.operations.get + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The server-assigned `name` of the operation. This + field has been deprecated and replaced by the name field. + in: path + name: operationId + required: true + schema: + type: string + - description: The name (project, location, operation id) of the operation to + get. Specified in the format `projects/*/locations/*/operations/*`. + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Cancels the specified operation. + operationId: container.projects.zones.operations.cancel + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the operation resides. This field has been deprecated and replaced + by the name field. + in: path + name: zone + required: true + schema: + type: string + - description: Deprecated. The server-assigned `name` of the operation. This + field has been deprecated and replaced by the name field. + in: path + name: operationId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectId}/zones/{zone}/serverconfig: + get: + description: Returns configuration info about the Google Kubernetes Engine service. + operationId: container.projects.zones.getServerconfig + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: path + name: projectId + required: true + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + to return operations for. This field has been deprecated and replaced by + the name field. + in: path + name: zone + required: true + schema: + type: string + - description: The name (project and location) of the server config to get, + specified in the format `projects/*/locations/*`. + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServerConfig' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectsId}/aggregated/usableSubnetworks: + get: + description: Lists subnetworks that are usable for creating clusters in a project. + operationId: container.projects.aggregated.usableSubnetworks.list + parameters: + - description: 'Filtering currently only supports equality on the networkProjectId + and must be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` + is the project which owns the listed subnetworks. This defaults to the parent + project ID.' + in: query + name: filter + schema: + type: string + - description: 'The max number of results per page that should be returned. + If the number of available results is larger than `page_size`, a `next_page_token` + is returned which can be used to get the next page of results in subsequent + requests. Acceptable values are 0 to 500, inclusive. (Default: 500)' + in: query + name: pageSize + schema: + type: integer + - description: Specifies a page token to use. Set this to the nextPageToken + returned by previous list requests to get the next page of results. + in: query + name: pageToken + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListUsableSubnetworksResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectsId}/locations/{locationsId}/clusters: + get: + description: Lists all clusters owned by a project in either the specified zone + or all zones. + operationId: container.projects.locations.clusters.list + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the parent field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides, or "-" for all zones. This field has been + deprecated and replaced by the parent field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListClustersResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a cluster, consisting of the specified number and type + of Google Compute Engine instances. By default, the cluster is created in + the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + One firewall is added for the cluster. After cluster creation, the Kubelet + creates routes for each node to allow the containers on that node to communicate + with all other instances in the cluster. Finally, an entry is added to the + project's global metadata indicating which CIDR range the cluster is using. + operationId: container.projects.locations.clusters.create + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}: + delete: + description: Deletes a node pool from a cluster. + operationId: container.projects.locations.clusters.nodePools.delete + parameters: + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: query + name: clusterId + schema: + type: string + - description: Deprecated. The name of the node pool to delete. This field has + been deprecated and replaced by the name field. + in: query + name: nodePoolId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + get: + description: Gets the specified operation. + operationId: container.projects.locations.operations.get + parameters: + - description: Deprecated. The server-assigned `name` of the operation. This + field has been deprecated and replaced by the name field. + in: query + name: operationId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + put: + description: Updates the version and/or image type for the specified node pool. + operationId: container.projects.locations.clusters.nodePools.update + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNodePoolRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration: + get: + description: Gets the OIDC discovery document for the cluster. See the [OpenID + Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.html) + for details. This API is not yet intended for general use, and is not available + for all clusters. + operationId: container.projects.locations.clusters.well-known.getOpenid-configuration + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetOpenIDConfigResponse' + description: Successful response + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/jwks: + get: + description: Gets the public component of the cluster signing keys in JSON Web + Key format. This API is not yet intended for general use, and is not available + for all clusters. + operationId: container.projects.locations.clusters.getJwks + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetJSONWebKeysResponse' + description: Successful response + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools: + get: + description: Lists the node pools for a cluster. + operationId: container.projects.locations.clusters.nodePools.list + parameters: + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the parent field. + in: query + name: clusterId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the parent field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the parent field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListNodePoolsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a node pool for a cluster. + operationId: container.projects.locations.clusters.nodePools.create + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNodePoolRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}: + delete: + description: Deletes a node pool from a cluster. + operationId: container.projects.locations.clusters.nodePools.delete + parameters: + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: query + name: clusterId + schema: + type: string + - description: Deprecated. The name of the node pool to delete. This field has + been deprecated and replaced by the name field. + in: query + name: nodePoolId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + get: + description: Gets the specified operation. + operationId: container.projects.locations.operations.get + parameters: + - description: Deprecated. The server-assigned `name` of the operation. This + field has been deprecated and replaced by the name field. + in: query + name: operationId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + put: + description: Updates the version and/or image type for the specified node pool. + operationId: container.projects.locations.clusters.nodePools.update + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNodePoolRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Rolls back a previously Aborted or Failed NodePool upgrade. This + makes no changes if the last upgrade successfully completed. + operationId: container.projects.locations.clusters.nodePools.rollback + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RollbackNodePoolUpgradeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the autoscaling settings for the specified node pool. + operationId: container.projects.locations.clusters.nodePools.setAutoscaling + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolAutoscalingRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the NodeManagement options for a node pool. + operationId: container.projects.locations.clusters.nodePools.setManagement + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolManagementRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setSize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the size for a specific node pool. The new size will be used + for all replicas, including future replicas created by modifying NodePool.locations. + operationId: container.projects.locations.clusters.nodePools.setSize + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolSizeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Completes master IP rotation. + operationId: container.projects.locations.clusters.completeIpRotation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompleteIPRotationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the addons for a specific cluster. + operationId: container.projects.locations.clusters.setAddons + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetAddonsConfigRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Enables or disables the ABAC authorization mechanism on a cluster. + operationId: container.projects.locations.clusters.setLegacyAbac + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLegacyAbacRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) + instead. + operationId: container.projects.locations.clusters.setLocations + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLocationsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the logging service for a specific cluster. + operationId: container.projects.locations.clusters.setLogging + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLoggingServiceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the maintenance policy for a cluster. + operationId: container.projects.locations.clusters.setMaintenancePolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMaintenancePolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets master auth materials. Currently supports changing the admin + password or a specific cluster, either via password generation or explicitly + setting the password. + operationId: container.projects.locations.clusters.setMasterAuth + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMasterAuthRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the monitoring service for a specific cluster. + operationId: container.projects.locations.clusters.setMonitoring + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMonitoringServiceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Enables or disables Network Policy for a cluster. + operationId: container.projects.locations.clusters.setNetworkPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNetworkPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets labels on a cluster. + operationId: container.projects.locations.clusters.setResourceLabels + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Starts master IP rotation. + operationId: container.projects.locations.clusters.startIpRotation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartIPRotationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Updates the master for a specific cluster. + operationId: container.projects.locations.clusters.updateMaster + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMasterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/operations: + get: + description: Lists all operations in a project in a specific zone or all zones. + operationId: container.projects.locations.operations.list + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the parent field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + to return operations for, or `-` for all zones. This field has been deprecated + and replaced by the parent field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + delete: + description: Deletes a node pool from a cluster. + operationId: container.projects.locations.clusters.nodePools.delete + parameters: + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: query + name: clusterId + schema: + type: string + - description: Deprecated. The name of the node pool to delete. This field has + been deprecated and replaced by the name field. + in: query + name: nodePoolId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + get: + description: Gets the specified operation. + operationId: container.projects.locations.operations.get + parameters: + - description: Deprecated. The server-assigned `name` of the operation. This + field has been deprecated and replaced by the name field. + in: query + name: operationId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + put: + description: Updates the version and/or image type for the specified node pool. + operationId: container.projects.locations.clusters.nodePools.update + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNodePoolRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Cancels the specified operation. + operationId: container.projects.locations.operations.cancel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/projects/{projectsId}/locations/{locationsId}/serverConfig: + get: + description: Returns configuration info about the Google Kubernetes Engine service. + operationId: container.projects.locations.getServerConfig + parameters: + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + to return operations for. This field has been deprecated and replaced by + the name field. + in: query + name: zone + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServerConfig' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/{name}: + delete: + description: Deletes a node pool from a cluster. + operationId: container.projects.locations.clusters.nodePools.delete + parameters: + - description: The name (project, location, cluster, node pool id) of the node + pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + in: path + name: name + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the name field. + in: query + name: clusterId + schema: + type: string + - description: Deprecated. The name of the node pool to delete. This field has + been deprecated and replaced by the name field. + in: query + name: nodePoolId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: query + name: zone + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + get: + description: Gets the specified operation. + operationId: container.projects.locations.operations.get + parameters: + - description: The name (project, location, operation id) of the operation to + get. Specified in the format `projects/*/locations/*/operations/*`. + in: path + name: name + required: true + schema: + type: string + - description: Deprecated. The server-assigned `name` of the operation. This + field has been deprecated and replaced by the name field. + in: query + name: operationId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the name field. + in: query + name: zone + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + put: + description: Updates the version and/or image type for the specified node pool. + operationId: container.projects.locations.clusters.nodePools.update + parameters: + - description: The name (project, location, cluster, node pool) of the node + pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNodePoolRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}/serverConfig: + get: + description: Returns configuration info about the Google Kubernetes Engine service. + operationId: container.projects.locations.getServerConfig + parameters: + - description: The name (project and location) of the server config to get, + specified in the format `projects/*/locations/*`. + in: path + name: name + required: true + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the name field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + to return operations for. This field has been deprecated and replaced by + the name field. + in: query + name: zone + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServerConfig' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/{name}:cancel: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Cancels the specified operation. + operationId: container.projects.locations.operations.cancel + parameters: + - description: The name (project, location, operation id) of the operation to + cancel. Specified in the format `projects/*/locations/*/operations/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:completeIpRotation: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Completes master IP rotation. + operationId: container.projects.locations.clusters.completeIpRotation + parameters: + - description: The name (project, location, cluster id) of the cluster to complete + IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompleteIPRotationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:rollback: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Rolls back a previously Aborted or Failed NodePool upgrade. This + makes no changes if the last upgrade successfully completed. + operationId: container.projects.locations.clusters.nodePools.rollback + parameters: + - description: The name (project, location, cluster, node pool id) of the node + poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RollbackNodePoolUpgradeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setAddons: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the addons for a specific cluster. + operationId: container.projects.locations.clusters.setAddons + parameters: + - description: The name (project, location, cluster) of the cluster to set addons. + Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetAddonsConfigRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setAutoscaling: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the autoscaling settings for the specified node pool. + operationId: container.projects.locations.clusters.nodePools.setAutoscaling + parameters: + - description: The name (project, location, cluster, node pool) of the node + pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolAutoscalingRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setLegacyAbac: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Enables or disables the ABAC authorization mechanism on a cluster. + operationId: container.projects.locations.clusters.setLegacyAbac + parameters: + - description: The name (project, location, cluster id) of the cluster to set + legacy abac. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLegacyAbacRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setLocations: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) + instead. + operationId: container.projects.locations.clusters.setLocations + parameters: + - description: The name (project, location, cluster) of the cluster to set locations. + Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLocationsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setLogging: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the logging service for a specific cluster. + operationId: container.projects.locations.clusters.setLogging + parameters: + - description: The name (project, location, cluster) of the cluster to set logging. + Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLoggingServiceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setMaintenancePolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the maintenance policy for a cluster. + operationId: container.projects.locations.clusters.setMaintenancePolicy + parameters: + - description: The name (project, location, cluster id) of the cluster to set + maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMaintenancePolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setManagement: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the NodeManagement options for a node pool. + operationId: container.projects.locations.clusters.nodePools.setManagement + parameters: + - description: The name (project, location, cluster, node pool id) of the node + pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolManagementRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setMasterAuth: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets master auth materials. Currently supports changing the admin + password or a specific cluster, either via password generation or explicitly + setting the password. + operationId: container.projects.locations.clusters.setMasterAuth + parameters: + - description: The name (project, location, cluster) of the cluster to set auth. + Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMasterAuthRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setMonitoring: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the monitoring service for a specific cluster. + operationId: container.projects.locations.clusters.setMonitoring + parameters: + - description: The name (project, location, cluster) of the cluster to set monitoring. + Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetMonitoringServiceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setNetworkPolicy: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Enables or disables Network Policy for a cluster. + operationId: container.projects.locations.clusters.setNetworkPolicy + parameters: + - description: The name (project, location, cluster id) of the cluster to set + networking policy. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNetworkPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setResourceLabels: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets labels on a cluster. + operationId: container.projects.locations.clusters.setResourceLabels + parameters: + - description: The name (project, location, cluster id) of the cluster to set + labels. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetLabelsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:setSize: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Sets the size for a specific node pool. The new size will be used + for all replicas, including future replicas created by modifying NodePool.locations. + operationId: container.projects.locations.clusters.nodePools.setSize + parameters: + - description: The name (project, location, cluster, node pool id) of the node + pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetNodePoolSizeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:startIpRotation: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Starts master IP rotation. + operationId: container.projects.locations.clusters.startIpRotation + parameters: + - description: The name (project, location, cluster id) of the cluster to start + IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartIPRotationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{name}:updateMaster: + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Updates the master for a specific cluster. + operationId: container.projects.locations.clusters.updateMaster + parameters: + - description: The name (project, location, cluster) of the cluster to update. + Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMasterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{parent}/.well-known/openid-configuration: + get: + description: Gets the OIDC discovery document for the cluster. See the [OpenID + Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.html) + for details. This API is not yet intended for general use, and is not available + for all clusters. + operationId: container.projects.locations.clusters.well-known.getOpenid-configuration + parameters: + - description: The cluster (project, location, cluster id) to get the discovery + document for. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: parent + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetOpenIDConfigResponse' + description: Successful response + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/{parent}/aggregated/usableSubnetworks: + get: + description: Lists subnetworks that are usable for creating clusters in a project. + operationId: container.projects.aggregated.usableSubnetworks.list + parameters: + - description: The parent project where subnetworks are usable. Specified in + the format `projects/*`. + in: path + name: parent + required: true + schema: + type: string + - description: 'Filtering currently only supports equality on the networkProjectId + and must be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` + is the project which owns the listed subnetworks. This defaults to the parent + project ID.' + in: query + name: filter + schema: + type: string + - description: 'The max number of results per page that should be returned. + If the number of available results is larger than `page_size`, a `next_page_token` + is returned which can be used to get the next page of results in subsequent + requests. Acceptable values are 0 to 500, inclusive. (Default: 500)' + in: query + name: pageSize + schema: + type: integer + - description: Specifies a page token to use. Set this to the nextPageToken + returned by previous list requests to get the next page of results. + in: query + name: pageToken + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListUsableSubnetworksResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/{parent}/clusters: + get: + description: Lists all clusters owned by a project in either the specified zone + or all zones. + operationId: container.projects.locations.clusters.list + parameters: + - description: The parent (project and location) where the clusters will be + listed. Specified in the format `projects/*/locations/*`. Location "-" matches + all zones and all regions. + in: path + name: parent + required: true + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the parent field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides, or "-" for all zones. This field has been + deprecated and replaced by the parent field. + in: query + name: zone + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListClustersResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a cluster, consisting of the specified number and type + of Google Compute Engine instances. By default, the cluster is created in + the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + One firewall is added for the cluster. After cluster creation, the Kubelet + creates routes for each node to allow the containers on that node to communicate + with all other instances in the cluster. Finally, an entry is added to the + project's global metadata indicating which CIDR range the cluster is using. + operationId: container.projects.locations.clusters.create + parameters: + - description: The parent (project and location) where the cluster will be created. + Specified in the format `projects/*/locations/*`. + in: path + name: parent + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{parent}/jwks: + get: + description: Gets the public component of the cluster signing keys in JSON Web + Key format. This API is not yet intended for general use, and is not available + for all clusters. + operationId: container.projects.locations.clusters.getJwks + parameters: + - description: The cluster (project, location, cluster id) to get keys for. + Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: parent + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetJSONWebKeysResponse' + description: Successful response + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + /v1/{parent}/nodePools: + get: + description: Lists the node pools for a cluster. + operationId: container.projects.locations.clusters.nodePools.list + parameters: + - description: The parent (project, location, cluster id) where the node pools + will be listed. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: parent + required: true + schema: + type: string + - description: Deprecated. The name of the cluster. This field has been deprecated + and replaced by the parent field. + in: query + name: clusterId + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://developers.google.com/console/help/new/#projectnumber). + This field has been deprecated and replaced by the parent field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced + by the parent field. + in: query + name: zone + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListNodePoolsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + post: + description: Creates a node pool for a cluster. + operationId: container.projects.locations.clusters.nodePools.create + parameters: + - description: The parent (project, location, cluster id) where the node pool + will be created. Specified in the format `projects/*/locations/*/clusters/*`. + in: path + name: parent + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNodePoolRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + /v1/{parent}/operations: + get: + description: Lists all operations in a project in a specific zone or all zones. + operationId: container.projects.locations.operations.list + parameters: + - description: The parent (project and location) where the operations will be + listed. Specified in the format `projects/*/locations/*`. Location "-" matches + all zones and all regions. + in: path + name: parent + required: true + schema: + type: string + - description: Deprecated. The Google Developers Console [project ID or project + number](https://support.google.com/cloud/answer/6158840). This field has + been deprecated and replaced by the parent field. + in: query + name: projectId + schema: + type: string + - description: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) + to return operations for, or `-` for all zones. This field has been deprecated + and replaced by the parent field. + in: query + name: zone + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + tags: + - projects + parameters: + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' +servers: +- url: https://container.googleapis.com/ +source: + url: {} +tags: +- name: projects diff --git a/test/registry/src/googleapis.com/v1/services/container-v1.yaml.sig b/test/registry/src/googleapis.com/v1/services/container-v1.yaml.sig new file mode 100644 index 00000000..a6b9874a --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services/container-v1.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELaF9xt0AKUzGMA/arDxWLU5gDd482AVi0tBDBiEUJmV+nHqryL02x+AJj95VXFnHJY4DxCefYCmm12i1jYlNDrq3cPyp+pCQ== \ No newline at end of file diff --git a/test/registry/src/googleapis.com/v1/services/storage-v1.yaml b/test/registry/src/googleapis.com/v1/services/storage-v1.yaml new file mode 100644 index 00000000..f12225fb --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services/storage-v1.yaml @@ -0,0 +1,5489 @@ +components: + parameters: + alt: + description: Data format for the response. + in: query + name: alt + schema: + enum: + - json + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: API key. Your API key identifies your project and provides you + with API access, quota, and reports. Required unless you provide an OAuth + 2.0 token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: An opaque string that represents a user for quota purposes. Must + not exceed 40 characters. + in: query + name: quotaUser + schema: + type: string + userIp: + description: Deprecated. Please use quotaUser instead. + in: query + name: userIp + schema: + type: string + schemas: + Bucket: + description: A bucket. + properties: + acl: + description: Access controls on the bucket. + items: + $ref: '#/components/schemas/BucketAccessControl' + type: array + autoclass: + description: The bucket's Autoclass configuration. + properties: + enabled: + description: Whether or not Autoclass is enabled on this bucket + type: boolean + toggleTime: + description: A date and time in RFC 3339 format representing the instant + at which "enabled" was last toggled. + format: date-time + type: string + type: object + billing: + description: The bucket's billing configuration. + properties: + requesterPays: + description: When set to true, Requester Pays is enabled for this bucket. + type: boolean + type: object + cors: + description: The bucket's Cross-Origin Resource Sharing (CORS) configuration. + items: + properties: + maxAgeSeconds: + description: The value, in seconds, to return in the Access-Control-Max-Age + header used in preflight responses. + format: int32 + type: integer + method: + description: 'The list of HTTP methods on which to include CORS response + headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the + list of methods, and means "any method".' + items: + type: string + type: array + origin: + description: 'The list of Origins eligible to receive CORS response + headers. Note: "*" is permitted in the list of origins, and means + "any Origin".' + items: + type: string + type: array + responseHeader: + description: The list of HTTP headers other than the simple response + headers to give permission for the user-agent to share across domains. + items: + type: string + type: array + type: object + type: array + customPlacementConfig: + description: The bucket's custom placement configuration for Custom Dual + Regions. + properties: + dataLocations: + description: The list of regional locations in which data is placed. + items: + type: string + type: array + type: object + defaultEventBasedHold: + description: The default value for event-based hold on newly created objects + in this bucket. Event-based hold is a way to retain objects indefinitely + until an event occurs, signified by the hold's release. After being released, + such objects will be subject to bucket-level retention (if any). One sample + use case of this flag is for banks to hold loan documents for at least + 3 years after loan is paid in full. Here, bucket-level retention is 3 + years and the event is loan being paid in full. In this example, these + objects will be held intact for any number of years until the event has + occurred (event-based hold on the object is released) and then 3 more + years after that. That means retention duration of the objects begins + from the moment event-based hold transitioned from true to false. Objects + under event-based hold cannot be deleted, overwritten or archived until + the hold is removed. + type: boolean + defaultObjectAcl: + description: Default access controls to apply to new objects when no ACL + is provided. + items: + $ref: '#/components/schemas/ObjectAccessControl' + type: array + encryption: + description: Encryption configuration for a bucket. + properties: + defaultKmsKeyName: + description: A Cloud KMS key that will be used to encrypt objects inserted + into this bucket, if no encryption method is specified. + type: string + type: object + etag: + description: HTTP 1.1 Entity tag for the bucket. + type: string + iamConfiguration: + description: The bucket's IAM configuration. + properties: + bucketPolicyOnly: + description: The bucket's uniform bucket-level access configuration. + The feature was formerly known as Bucket Policy Only. For backward + compatibility, this field will be populated with identical information + as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess + field to enable and disable the feature. + properties: + enabled: + description: If set, access is controlled only by bucket-level or + above IAM policies. + type: boolean + lockedTime: + description: The deadline for changing iamConfiguration.bucketPolicyOnly.enabled + from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled + may be changed from true to false until the locked time, after + which the field is immutable. + format: date-time + type: string + type: object + publicAccessPrevention: + description: The bucket's Public Access Prevention configuration. Currently, + 'inherited' and 'enforced' are supported. + type: string + uniformBucketLevelAccess: + description: The bucket's uniform bucket-level access configuration. + properties: + enabled: + description: If set, access is controlled only by bucket-level or + above IAM policies. + type: boolean + lockedTime: + description: The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled + from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled + may be changed from true to false until the locked time, after + which the field is immutable. + format: date-time + type: string + type: object + type: object + id: + description: The ID of the bucket. For buckets, the id and name properties + are the same. + type: string + kind: + default: storage#bucket + description: The kind of item this is. For buckets, this is always storage#bucket. + type: string + labels: + additionalProperties: + description: An individual label entry. + type: string + description: User-provided labels, in key/value pairs. + type: object + lifecycle: + description: The bucket's lifecycle configuration. See lifecycle management + for more information. + properties: + rule: + description: A lifecycle management rule, which is made of an action + to take and the condition(s) under which the action will be taken. + items: + properties: + action: + description: The action to take. + properties: + storageClass: + description: Target storage class. Required iff the type of + the action is SetStorageClass. + type: string + type: + description: Type of the action. Currently, only Delete and + SetStorageClass are supported. + type: string + type: object + condition: + description: The condition(s) under which the action will be taken. + properties: + age: + description: Age of an object (in days). This condition is + satisfied when an object reaches the specified age. + format: int32 + type: integer + createdBefore: + description: A date in RFC 3339 format with only the date + part (for instance, "2013-01-15"). This condition is satisfied + when an object is created before midnight of the specified + date in UTC. + format: date + type: string + customTimeBefore: + description: A date in RFC 3339 format with only the date + part (for instance, "2013-01-15"). This condition is satisfied + when the custom time on an object is before this date in + UTC. + format: date + type: string + daysSinceCustomTime: + description: Number of days elapsed since the user-specified + timestamp set on an object. The condition is satisfied if + the days elapsed is at least this number. If no custom timestamp + is specified on an object, the condition does not apply. + format: int32 + type: integer + daysSinceNoncurrentTime: + description: Number of days elapsed since the noncurrent timestamp + of an object. The condition is satisfied if the days elapsed + is at least this number. This condition is relevant only + for versioned objects. The value of the field must be a + nonnegative integer. If it's zero, the object version will + become eligible for Lifecycle action as soon as it becomes + noncurrent. + format: int32 + type: integer + isLive: + description: Relevant only for versioned objects. If the value + is true, this condition matches live objects; if the value + is false, it matches archived objects. + type: boolean + matchesPattern: + description: 'A regular expression that satisfies the RE2 + syntax. This condition is satisfied when the name of the + object matches the RE2 pattern. Note: This feature is currently + in the "Early Access" launch stage and is only available + to a whitelisted set of users; that means that this feature + may be changed in backward-incompatible ways and that it + is not guaranteed to be released.' + type: string + matchesStorageClass: + description: Objects having any of the storage classes specified + by this condition will be matched. Values include MULTI_REGIONAL, + REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. + items: + type: string + type: array + noncurrentTimeBefore: + description: A date in RFC 3339 format with only the date + part (for instance, "2013-01-15"). This condition is satisfied + when the noncurrent time on an object is before this date + in UTC. This condition is relevant only for versioned objects. + format: date + type: string + numNewerVersions: + description: Relevant only for versioned objects. If the value + is N, this condition is satisfied when there are at least + N versions (including the live version) newer than this + version of the object. + format: int32 + type: integer + type: object + type: object + type: array + type: object + location: + description: The location of the bucket. Object data for objects in the + bucket resides in physical storage within this region. Defaults to US. + See the developer's guide for the authoritative list. + type: string + locationType: + description: The type of the bucket location. + type: string + logging: + description: The bucket's logging configuration, which defines the destination + bucket and optional name prefix for the current bucket's logs. + properties: + logBucket: + description: The destination bucket where the current bucket's logs + should be placed. + type: string + logObjectPrefix: + description: A prefix for log object names. + type: string + type: object + metageneration: + description: The metadata generation of this bucket. + format: int64 + type: string + name: + description: The name of the bucket. + type: string + owner: + description: The owner of the bucket. This is always the project team's + owner group. + properties: + entity: + description: The entity, in the form project-owner-projectId. + type: string + entityId: + description: The ID for the entity. + type: string + type: object + projectNumber: + description: The project number of the project the bucket belongs to. + format: uint64 + type: string + retentionPolicy: + description: The bucket's retention policy. The retention policy enforces + a minimum retention time for all objects contained in the bucket, based + on their creation time. Any attempt to overwrite or delete objects younger + than the retention period will result in a PERMISSION_DENIED error. An + unlocked retention policy can be modified or removed from the bucket via + a storage.buckets.update operation. A locked retention policy cannot be + removed or shortened in duration for the lifetime of the bucket. Attempting + to remove or decrease period of a locked retention policy will result + in a PERMISSION_DENIED error. + properties: + effectiveTime: + description: Server-determined value that indicates the time from which + policy was enforced and effective. This value is in RFC 3339 format. + format: date-time + type: string + isLocked: + description: Once locked, an object retention policy cannot be modified. + type: boolean + retentionPeriod: + description: The duration in seconds that objects need to be retained. + Retention duration must be greater than zero and less than 100 years. + Note that enforcement of retention periods less than a day is not + guaranteed. Such periods should only be used for testing purposes. + format: int64 + type: string + type: object + rpo: + description: The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO + to turn on Turbo Replication on a bucket. + type: string + satisfiesPZS: + description: Reserved for future use. + type: boolean + selfLink: + description: The URI of this bucket. + type: string + storageClass: + description: The bucket's default storage class, used whenever no storageClass + is specified for a newly-created object. This defines how objects in the + bucket are stored and determines the SLA and the cost of storage. Values + include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, + and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when + the bucket is created, it will default to STANDARD. For more information, + see storage classes. + type: string + timeCreated: + description: The creation time of the bucket in RFC 3339 format. + format: date-time + type: string + updated: + description: The modification time of the bucket in RFC 3339 format. + format: date-time + type: string + versioning: + description: The bucket's versioning configuration. + properties: + enabled: + description: While set to true, versioning is fully enabled for this + bucket. + type: boolean + type: object + website: + description: The bucket's website configuration, controlling how the service + behaves when accessing bucket contents as a web site. See the Static Website + Examples for more information. + properties: + mainPageSuffix: + description: If the requested object path is missing, the service will + ensure the path has a trailing '/', append this suffix, and attempt + to retrieve the resulting object. This allows the creation of index.html + objects to represent directory pages. + type: string + notFoundPage: + description: If the requested object path is missing, and any mainPageSuffix + object is missing, if applicable, the service will return the named + object from this bucket as the content for a 404 Not Found result. + type: string + type: object + type: object + BucketAccessControl: + description: An access-control entry. + properties: + bucket: + description: The name of the bucket. + type: string + domain: + description: The domain associated with the entity, if any. + type: string + email: + description: The email address associated with the entity, if any. + type: string + entity: + description: "The entity holding the permission, in one of the following\ + \ forms: \n- user-userId \n- user-email \n- group-groupId \n- group-email\ + \ \n- domain-domain \n- project-team-projectId \n- allUsers \n- allAuthenticatedUsers\ + \ Examples: \n- The user liz@example.com would be user-liz@example.com.\ + \ \n- The group example@googlegroups.com would be group-example@googlegroups.com.\ + \ \n- To refer to all members of the Google Apps for Business domain example.com,\ + \ the entity would be domain-example.com." + type: string + entityId: + description: The ID for the entity, if any. + type: string + etag: + description: HTTP 1.1 Entity tag for the access-control entry. + type: string + id: + description: The ID of the access-control entry. + type: string + kind: + default: storage#bucketAccessControl + description: The kind of item this is. For bucket access control entries, + this is always storage#bucketAccessControl. + type: string + projectTeam: + description: The project team associated with the entity, if any. + properties: + projectNumber: + description: The project number. + type: string + team: + description: The team. + type: string + type: object + role: + description: The access permission for the entity. + type: string + selfLink: + description: The link to this access-control entry. + type: string + type: object + BucketAccessControls: + description: An access-control list. + properties: + items: + description: The list of items. + items: + $ref: '#/components/schemas/BucketAccessControl' + type: array + kind: + default: storage#bucketAccessControls + description: The kind of item this is. For lists of bucket access control + entries, this is always storage#bucketAccessControls. + type: string + type: object + Buckets: + description: A list of buckets. + properties: + items: + description: The list of items. + items: + $ref: '#/components/schemas/Bucket' + type: array + kind: + default: storage#buckets + description: The kind of item this is. For lists of buckets, this is always + storage#buckets. + type: string + nextPageToken: + description: The continuation token, used to page through large result sets. + Provide this value in a subsequent request to return the next page of + results. + type: string + type: object + Channel: + description: An notification channel used to watch for resource changes. + properties: + address: + description: The address where notifications are delivered for this channel. + type: string + expiration: + description: Date and time of notification channel expiration, expressed + as a Unix timestamp, in milliseconds. Optional. + format: int64 + type: string + id: + description: A UUID or similar unique string that identifies this channel. + type: string + kind: + default: api#channel + description: Identifies this as a notification channel used to watch for + changes to a resource, which is "api#channel". + type: string + params: + additionalProperties: + description: Declares a new parameter by name. + type: string + description: Additional parameters controlling delivery channel behavior. + Optional. + type: object + payload: + description: A Boolean value to indicate whether payload is wanted. Optional. + type: boolean + resourceId: + description: An opaque ID that identifies the resource being watched on + this channel. Stable across different API versions. + type: string + resourceUri: + description: A version-specific identifier for the watched resource. + type: string + token: + description: An arbitrary string delivered to the target address with each + notification delivered over this channel. Optional. + type: string + type: + description: The type of delivery mechanism used for this channel. + type: string + type: object + ComposeRequest: + description: A Compose request. + properties: + destination: + $ref: '#/components/schemas/Object' + description: Properties of the resulting object. + kind: + default: storage#composeRequest + description: The kind of item this is. + type: string + sourceObjects: + description: The list of source objects that will be concatenated into a + single object. + items: + properties: + generation: + description: The generation of this object to use as the source. + format: int64 + type: string + name: + description: The source object's name. All source objects must reside + in the same bucket. + type: string + objectPreconditions: + description: Conditions that must be met for this operation to execute. + properties: + ifGenerationMatch: + description: Only perform the composition if the generation of + the source object that would be used matches this value. If + this value and a generation are both specified, they must be + the same value or the call will fail. + format: int64 + type: string + type: object + type: object + type: array + type: object + Expr: + description: 'Represents an expression text. Example: title: "User account presence" + description: "Determines whether the request has a user account" expression: + "size(request.user) > 0"' + properties: + description: + description: An 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. The application context of the containing message determines + which well-known feature set of CEL is supported. + type: string + location: + description: An 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: An 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 + HmacKey: + description: JSON template to produce a JSON-style HMAC Key resource for Create + responses. + properties: + kind: + default: storage#hmacKey + description: The kind of item this is. For HMAC keys, this is always storage#hmacKey. + type: string + metadata: + $ref: '#/components/schemas/HmacKeyMetadata' + description: Key metadata. + secret: + description: HMAC secret key material. + type: string + type: object + HmacKeyMetadata: + description: JSON template to produce a JSON-style HMAC Key metadata resource. + properties: + accessId: + description: The ID of the HMAC Key. + type: string + etag: + description: HTTP 1.1 Entity tag for the HMAC key. + type: string + id: + description: The ID of the HMAC key, including the Project ID and the Access + ID. + type: string + kind: + default: storage#hmacKeyMetadata + description: The kind of item this is. For HMAC Key metadata, this is always + storage#hmacKeyMetadata. + type: string + projectId: + description: Project ID owning the service account to which the key authenticates. + type: string + selfLink: + description: The link to this resource. + type: string + serviceAccountEmail: + description: The email address of the key's associated service account. + type: string + state: + description: The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED. + type: string + timeCreated: + description: The creation time of the HMAC key in RFC 3339 format. + format: date-time + type: string + updated: + description: The last modification time of the HMAC key metadata in RFC + 3339 format. + format: date-time + type: string + type: object + HmacKeysMetadata: + description: A list of hmacKeys. + properties: + items: + description: The list of items. + items: + $ref: '#/components/schemas/HmacKeyMetadata' + type: array + kind: + default: storage#hmacKeysMetadata + description: The kind of item this is. For lists of hmacKeys, this is always + storage#hmacKeysMetadata. + type: string + nextPageToken: + description: The continuation token, used to page through large result sets. + Provide this value in a subsequent request to return the next page of + results. + type: string + type: object + Notification: + description: A subscription to receive Google PubSub notifications. + properties: + custom_attributes: + additionalProperties: + type: string + description: An optional list of additional attributes to attach to each + Cloud PubSub message published for this notification subscription. + type: object + etag: + description: HTTP 1.1 Entity tag for this subscription notification. + type: string + event_types: + description: If present, only send notifications about listed event types. + If empty, sent notifications for all event types. + items: + type: string + type: array + id: + description: The ID of the notification. + type: string + kind: + default: storage#notification + description: The kind of item this is. For notifications, this is always + storage#notification. + type: string + object_name_prefix: + description: If present, only apply this notification configuration to object + names that begin with this prefix. + type: string + payload_format: + default: JSON_API_V1 + description: The desired content of the Payload. + type: string + selfLink: + description: The canonical URL of this notification. + type: string + topic: + description: 'The Cloud PubSub topic to which this subscription publishes. + Formatted as: ''//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}''' + type: string + type: object + Notifications: + description: A list of notification subscriptions. + properties: + items: + description: The list of items. + items: + $ref: '#/components/schemas/Notification' + type: array + kind: + default: storage#notifications + description: The kind of item this is. For lists of notifications, this + is always storage#notifications. + type: string + type: object + Object: + description: An object. + properties: + acl: + description: Access controls on the object. + items: + $ref: '#/components/schemas/ObjectAccessControl' + type: array + bucket: + description: The name of the bucket containing this object. + type: string + cacheControl: + description: Cache-Control directive for the object data. If omitted, and + the object is accessible to all anonymous users, the default will be public, + max-age=3600. + type: string + componentCount: + description: Number of underlying components that make up this object. Components + are accumulated by compose operations. + format: int32 + type: integer + contentDisposition: + description: Content-Disposition of the object data. + type: string + contentEncoding: + description: Content-Encoding of the object data. + type: string + contentLanguage: + description: Content-Language of the object data. + type: string + contentType: + description: Content-Type of the object data. If an object is stored without + a Content-Type, it is served as application/octet-stream. + type: string + crc32c: + description: 'CRC32c checksum, as described in RFC 4960, Appendix B; encoded + using base64 in big-endian byte order. For more information about using + the CRC32c checksum, see Hashes and ETags: Best Practices.' + type: string + customTime: + description: A timestamp in RFC 3339 format specified by the user for an + object. + format: date-time + type: string + customerEncryption: + description: Metadata of customer-supplied encryption key, if the object + is encrypted by such a key. + properties: + encryptionAlgorithm: + description: The encryption algorithm. + type: string + keySha256: + description: SHA256 hash value of the encryption key. + type: string + type: object + etag: + description: HTTP 1.1 Entity tag for the object. + type: string + eventBasedHold: + description: Whether an object is under event-based hold. Event-based hold + is a way to retain objects until an event occurs, which is signified by + the hold's release (i.e. this value is set to false). After being released + (set to false), such objects will be subject to bucket-level retention + (if any). One sample use case of this flag is for banks to hold loan documents + for at least 3 years after loan is paid in full. Here, bucket-level retention + is 3 years and the event is the loan being paid in full. In this example, + these objects will be held intact for any number of years until the event + has occurred (event-based hold on the object is released) and then 3 more + years after that. That means retention duration of the objects begins + from the moment event-based hold transitioned from true to false. + type: boolean + generation: + description: The content generation of this object. Used for object versioning. + format: int64 + type: string + id: + description: The ID of the object, including the bucket name, object name, + and generation number. + type: string + kind: + default: storage#object + description: The kind of item this is. For objects, this is always storage#object. + type: string + kmsKeyName: + description: Not currently supported. Specifying the parameter causes the + request to fail with status code 400 - Bad Request. + type: string + md5Hash: + description: 'MD5 hash of the data; encoded using base64. For more information + about using the MD5 hash, see Hashes and ETags: Best Practices.' + type: string + mediaLink: + description: Media download link. + type: string + metadata: + additionalProperties: + description: An individual metadata entry. + type: string + description: User-provided metadata, in key/value pairs. + type: object + metageneration: + description: The version of the metadata for this object at this generation. + Used for preconditions and for detecting changes in metadata. A metageneration + number is only meaningful in the context of a particular generation of + a particular object. + format: int64 + type: string + name: + description: The name of the object. Required if not specified by URL parameter. + type: string + owner: + description: The owner of the object. This will always be the uploader of + the object. + properties: + entity: + description: The entity, in the form user-userId. + type: string + entityId: + description: The ID for the entity. + type: string + type: object + retentionExpirationTime: + description: 'A server-determined value that specifies the earliest time + that the object''s retention period expires. This value is in RFC 3339 + format. Note 1: This field is not provided for objects with an active + event-based hold, since retention expiration is unknown until the hold + is removed. Note 2: This value can be provided even when temporary hold + is set (so that the user can reason about policy without having to first + unset the temporary hold).' + format: date-time + type: string + selfLink: + description: The link to this object. + type: string + size: + description: Content-Length of the data in bytes. + format: uint64 + type: string + storageClass: + description: Storage class of the object. + type: string + temporaryHold: + description: Whether an object is under temporary hold. While this flag + is set to true, the object is protected against deletion and overwrites. + A common use case of this flag is regulatory investigations where objects + need to be retained while the investigation is ongoing. Note that unlike + event-based hold, temporary hold does not impact retention expiration + time of an object. + type: boolean + timeCreated: + description: The creation time of the object in RFC 3339 format. + format: date-time + type: string + timeDeleted: + description: The deletion time of the object in RFC 3339 format. Will be + returned if and only if this version of the object has been deleted. + format: date-time + type: string + timeStorageClassUpdated: + description: The time at which the object's storage class was last changed. + When the object is initially created, it will be set to timeCreated. + format: date-time + type: string + updated: + description: The modification time of the object metadata in RFC 3339 format. + format: date-time + type: string + type: object + ObjectAccessControl: + description: An access-control entry. + properties: + bucket: + description: The name of the bucket. + type: string + domain: + description: The domain associated with the entity, if any. + type: string + email: + description: The email address associated with the entity, if any. + type: string + entity: + description: "The entity holding the permission, in one of the following\ + \ forms: \n- user-userId \n- user-email \n- group-groupId \n- group-email\ + \ \n- domain-domain \n- project-team-projectId \n- allUsers \n- allAuthenticatedUsers\ + \ Examples: \n- The user liz@example.com would be user-liz@example.com.\ + \ \n- The group example@googlegroups.com would be group-example@googlegroups.com.\ + \ \n- To refer to all members of the Google Apps for Business domain example.com,\ + \ the entity would be domain-example.com." + type: string + entityId: + description: The ID for the entity, if any. + type: string + etag: + description: HTTP 1.1 Entity tag for the access-control entry. + type: string + generation: + description: The content generation of the object, if applied to an object. + format: int64 + type: string + id: + description: The ID of the access-control entry. + type: string + kind: + default: storage#objectAccessControl + description: The kind of item this is. For object access control entries, + this is always storage#objectAccessControl. + type: string + object: + description: The name of the object, if applied to an object. + type: string + projectTeam: + description: The project team associated with the entity, if any. + properties: + projectNumber: + description: The project number. + type: string + team: + description: The team. + type: string + type: object + role: + description: The access permission for the entity. + type: string + selfLink: + description: The link to this access-control entry. + type: string + type: object + ObjectAccessControls: + description: An access-control list. + properties: + items: + description: The list of items. + items: + $ref: '#/components/schemas/ObjectAccessControl' + type: array + kind: + default: storage#objectAccessControls + description: The kind of item this is. For lists of object access control + entries, this is always storage#objectAccessControls. + type: string + type: object + Objects: + description: A list of objects. + properties: + items: + description: The list of items. + items: + $ref: '#/components/schemas/Object' + type: array + kind: + default: storage#objects + description: The kind of item this is. For lists of objects, this is always + storage#objects. + type: string + nextPageToken: + description: The continuation token, used to page through large result sets. + Provide this value in a subsequent request to return the next page of + results. + type: string + prefixes: + description: The list of prefixes of objects matching-but-not-listed up + to and including the requested delimiter. + items: + type: string + type: array + type: object + Policy: + description: A bucket/object IAM policy. + properties: + bindings: + description: An association between a role, which comes with a set of permissions, + and members who may assume that role. + items: + properties: + condition: + $ref: '#/components/schemas/Expr' + description: 'The condition that is associated with this binding. + NOTE: an unsatisfied condition will not allow user access via current + binding. Different bindings, including their conditions, are examined + independently.' + members: + description: "A collection of identifiers for members who may assume\ + \ the provided role. Recognized identifiers are as follows: \n\ + - allUsers \u2014 A special identifier that represents anyone on\ + \ the internet; with or without a Google account. \n- allAuthenticatedUsers\ + \ \u2014 A special identifier that represents anyone who is authenticated\ + \ with a Google account or a service account. \n- user:emailid\ + \ \u2014 An email address that represents a specific account. For\ + \ example, user:alice@gmail.com or user:joe@example.com. \n- serviceAccount:emailid\ + \ \u2014 An email address that represents a service account. For\ + \ example, serviceAccount:my-other-app@appspot.gserviceaccount.com\ + \ . \n- group:emailid \u2014 An email address that represents a\ + \ Google group. For example, group:admins@example.com. \n- domain:domain\ + \ \u2014 A Google Apps domain name that represents all the users\ + \ of that domain. For example, domain:google.com or domain:example.com.\ + \ \n- projectOwner:projectid \u2014 Owners of the given project.\ + \ For example, projectOwner:my-example-project \n- projectEditor:projectid\ + \ \u2014 Editors of the given project. For example, projectEditor:my-example-project\ + \ \n- projectViewer:projectid \u2014 Viewers of the given project.\ + \ For example, projectViewer:my-example-project" + items: + type: string + type: array + role: + description: "The role to which members belong. Two types of roles\ + \ are supported: new IAM roles, which grant permissions that do\ + \ not map directly to those provided by ACLs, and legacy IAM roles,\ + \ which do map directly to ACL permissions. All roles are of the\ + \ format roles/storage.specificRole.\nThe new IAM roles are: \n\ + - roles/storage.admin \u2014 Full control of Google Cloud Storage\ + \ resources. \n- roles/storage.objectViewer \u2014 Read-Only access\ + \ to Google Cloud Storage objects. \n- roles/storage.objectCreator\ + \ \u2014 Access to create objects in Google Cloud Storage. \n-\ + \ roles/storage.objectAdmin \u2014 Full control of Google Cloud\ + \ Storage objects. The legacy IAM roles are: \n- roles/storage.legacyObjectReader\ + \ \u2014 Read-only access to objects without listing. Equivalent\ + \ to an ACL entry on an object with the READER role. \n- roles/storage.legacyObjectOwner\ + \ \u2014 Read/write access to existing objects without listing.\ + \ Equivalent to an ACL entry on an object with the OWNER role. \ + \ \n- roles/storage.legacyBucketReader \u2014 Read access to buckets\ + \ with object listing. Equivalent to an ACL entry on a bucket with\ + \ the READER role. \n- roles/storage.legacyBucketWriter \u2014\ + \ Read access to buckets with object listing/creation/deletion.\ + \ Equivalent to an ACL entry on a bucket with the WRITER role. \ + \ \n- roles/storage.legacyBucketOwner \u2014 Read and write access\ + \ to existing buckets with object listing/creation/deletion. Equivalent\ + \ to an ACL entry on a bucket with the OWNER role." + type: string + type: object + type: array + etag: + description: HTTP 1.1 Entity tag for the policy. + format: byte + type: string + kind: + default: storage#policy + description: The kind of item this is. For policies, this is always storage#policy. + This field is ignored on input. + type: string + resourceId: + description: 'The ID of the resource to which this policy belongs. Will + be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object + for objects. A specific generation may be specified by appending #generationNumber + to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. + The current generation can be denoted with #0. This field is ignored on + input.' + type: string + version: + description: The IAM policy format version. + format: int32 + type: integer + type: object + RewriteResponse: + description: A rewrite response. + properties: + done: + description: true if the copy is finished; otherwise, false if the copy + is in progress. This property is always present in the response. + type: boolean + kind: + default: storage#rewriteResponse + description: The kind of item this is. + type: string + objectSize: + description: The total size of the object being copied in bytes. This property + is always present in the response. + format: int64 + type: string + resource: + $ref: '#/components/schemas/Object' + description: A resource containing the metadata for the copied-to object. + This property is present in the response only when copying completes. + rewriteToken: + description: A token to use in subsequent requests to continue copying data. + This token is present in the response only when there is more data to + copy. + type: string + totalBytesRewritten: + description: The total bytes written so far, which can be used to provide + a waiting user with a progress indicator. This property is always present + in the response. + format: int64 + type: string + type: object + ServiceAccount: + description: A subscription to receive Google PubSub notifications. + properties: + email_address: + description: The ID of the notification. + type: string + kind: + default: storage#serviceAccount + description: The kind of item this is. For notifications, this is always + storage#notification. + type: string + type: object + TestIamPermissionsResponse: + description: A storage.(buckets|objects).testIamPermissions response. + properties: + kind: + default: storage#testIamPermissionsResponse + description: The kind of item this is. + type: string + permissions: + description: "The permissions held by the caller. Permissions are always\ + \ of the format storage.resource.capability, where resource is one of\ + \ buckets or objects. The supported permissions are as follows: \n- storage.buckets.delete\ + \ \u2014 Delete bucket. \n- storage.buckets.get \u2014 Read bucket metadata.\ + \ \n- storage.buckets.getIamPolicy \u2014 Read bucket IAM policy. \n\ + - storage.buckets.create \u2014 Create bucket. \n- storage.buckets.list\ + \ \u2014 List buckets. \n- storage.buckets.setIamPolicy \u2014 Update\ + \ bucket IAM policy. \n- storage.buckets.update \u2014 Update bucket\ + \ metadata. \n- storage.objects.delete \u2014 Delete object. \n- storage.objects.get\ + \ \u2014 Read object data and metadata. \n- storage.objects.getIamPolicy\ + \ \u2014 Read object IAM policy. \n- storage.objects.create \u2014 Create\ + \ object. \n- storage.objects.list \u2014 List objects. \n- storage.objects.setIamPolicy\ + \ \u2014 Update object IAM policy. \n- storage.objects.update \u2014\ + \ Update object metadata." + items: + type: string + type: array + type: object + securitySchemes: + Oauth2: + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: View and manage your data + across Google Cloud Platform services + https://www.googleapis.com/auth/cloud-platform.read-only: View your data + across Google Cloud Platform services + https://www.googleapis.com/auth/devstorage.full_control: Manage your data + and permissions in Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_only: View your data in + Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_write: Manage your data + in Google Cloud Storage + type: oauth2 + Oauth2c: + description: Oauth 2.0 authorizationCode authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: + https://www.googleapis.com/auth/cloud-platform: View and manage your data + across Google Cloud Platform services + https://www.googleapis.com/auth/cloud-platform.read-only: View your data + across Google Cloud Platform services + https://www.googleapis.com/auth/devstorage.full_control: Manage your data + and permissions in Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_only: View your data in + Google Cloud Storage + https://www.googleapis.com/auth/devstorage.read_write: Manage your data + in Google Cloud Storage + tokenUrl: https://accounts.google.com/o/oauth2/token + type: oauth2 + x-stackQL-resources: + bucketAccessControls: + id: google.storage.bucketAccessControls + methods: + delete: + operation: + $ref: delete + path: + $ref: /b/{bucket}/acl/{entity} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /b/{bucket}/acl/{entity} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /b/{bucket}/acl + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /b/{bucket}/acl + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /b/{bucket}/acl/{entity} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /b/{bucket}/acl/{entity} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: bucketAccessControls + title: bucketAccessControls + buckets: + id: google.storage.buckets + methods: + delete: + operation: + $ref: delete + path: + $ref: /b/{bucket} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /b/{bucket} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /b/{bucket}/iam + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /b + request: + mediaType: application/json + required: + - name + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /b + response: + mediaType: application/json + openAPIDocKey: '200' + lockRetentionPolicy: + operation: + $ref: post + path: + $ref: /b/{bucket}/lockRetentionPolicy + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /b/{bucket} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: put + path: + $ref: /b/{bucket}/iam + request: + mediaType: application/json + required: + - bindings + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: get + path: + $ref: /b/{bucket}/iam/testPermissions + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /b/{bucket} + request: + mediaType: application/json + required: + - acl + response: + mediaType: application/json + openAPIDocKey: '200' + name: buckets + title: buckets + channels: + id: google.storage.channels + methods: + stop: + operation: + $ref: post + path: + $ref: /channels/stop + request: + mediaType: application/json + response: + openAPIDocKey: '200' + name: channels + title: channels + defaultObjectAccessControls: + id: google.storage.defaultObjectAccessControls + methods: + delete: + operation: + $ref: delete + path: + $ref: /b/{bucket}/defaultObjectAcl/{entity} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /b/{bucket}/defaultObjectAcl/{entity} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /b/{bucket}/defaultObjectAcl + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /b/{bucket}/defaultObjectAcl + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /b/{bucket}/defaultObjectAcl/{entity} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /b/{bucket}/defaultObjectAcl/{entity} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: defaultObjectAccessControls + title: defaultObjectAccessControls + notifications: + id: google.storage.notifications + methods: + delete: + operation: + $ref: delete + path: + $ref: /b/{bucket}/notificationConfigs/{notification} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /b/{bucket}/notificationConfigs/{notification} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /b/{bucket}/notificationConfigs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /b/{bucket}/notificationConfigs + response: + mediaType: application/json + openAPIDocKey: '200' + name: notifications + title: notifications + objectAccessControls: + id: google.storage.objectAccessControls + methods: + delete: + operation: + $ref: delete + path: + $ref: /b/{bucket}/o/{object}/acl/{entity} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /b/{bucket}/o/{object}/acl/{entity} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /b/{bucket}/o/{object}/acl + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /b/{bucket}/o/{object}/acl + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /b/{bucket}/o/{object}/acl/{entity} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /b/{bucket}/o/{object}/acl/{entity} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: objectAccessControls + title: objectAccessControls + objects: + id: google.storage.objects + methods: + compose: + operation: + $ref: post + path: + $ref: /b/{destinationBucket}/o/{destinationObject}/compose + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + copy: + operation: + $ref: post + path: + $ref: /b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /b/{bucket}/o/{object} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /b/{bucket}/o/{object} + response: + mediaType: application/json + openAPIDocKey: '200' + getIamPolicy: + operation: + $ref: get + path: + $ref: /b/{bucket}/o/{object}/iam + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: post + path: + $ref: /b/{bucket}/o + request: + mediaType: application/octet-stream + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /b/{bucket}/o + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: patch + path: + $ref: /b/{bucket}/o/{object} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + rewrite: + operation: + $ref: post + path: + $ref: /b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + setIamPolicy: + operation: + $ref: put + path: + $ref: /b/{bucket}/o/{object}/iam + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + testIamPermissions: + operation: + $ref: get + path: + $ref: /b/{bucket}/o/{object}/iam/testPermissions + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /b/{bucket}/o/{object} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + watchAll: + operation: + $ref: post + path: + $ref: /b/{bucket}/o/watch + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: objects + title: objects + projects.hmacKeys: + id: google.storage.projects.hmacKeys + methods: + create: + operation: + $ref: post + path: + $ref: /projects/{projectId}/hmacKeys + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: delete + path: + $ref: /projects/{projectId}/hmacKeys/{accessId} + response: + openAPIDocKey: '200' + get: + operation: + $ref: get + path: + $ref: /projects/{projectId}/hmacKeys/{accessId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: get + path: + $ref: /projects/{projectId}/hmacKeys + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: put + path: + $ref: /projects/{projectId}/hmacKeys/{accessId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.hmacKeys + title: projects.hmacKeys + projects.serviceAccount: + id: google.storage.projects.serviceAccount + methods: + get: + operation: + $ref: get + path: + $ref: /projects/{projectId}/serviceAccount + response: + mediaType: application/json + openAPIDocKey: '200' + name: projects.serviceAccount + title: projects.serviceAccount +externalDocs: + url: https://developers.google.com/storage/docs/json_api/ +info: + contact: + name: Google + url: https://google.com + x-twitter: youtube + description: Stores and retrieves potentially large, immutable data objects. + license: + name: Creative Commons Attribution 3.0 + url: http://creativecommons.org/licenses/by/3.0/ + termsOfService: https://developers.google.com/terms/ + title: Cloud Storage JSON API + version: v1 + x-apiClientRegistration: + url: https://console.developers.google.com + x-apisguru-categories: + - analytics + - media + x-logo: + url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png + x-origin: + - format: google + url: https://storage.googleapis.com/$discovery/rest?version=v1 + version: v1 + x-preferred: true + x-providerName: googleapis.com + x-serviceName: storage +openapi: 3.0.0 +paths: + /b: + get: + description: Retrieves a list of buckets for a given project. + operationId: storage.buckets.list + parameters: + - description: A valid API project identifier. + in: query + name: project + required: true + schema: + type: string + - description: Maximum number of buckets to return in a single response. The + service will use this parameter or 1,000 items, whichever is smaller. + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - description: A previously-returned page token representing part of the larger + set of results to view. + in: query + name: pageToken + schema: + type: string + - description: Filter results to buckets whose names begin with this prefix. + in: query + name: prefix + schema: + type: string + - description: Set of properties to return. Defaults to noAcl. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Buckets' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - buckets + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new bucket. + operationId: storage.buckets.insert + parameters: + - description: A valid API project identifier. + in: query + name: project + required: true + schema: + type: string + - description: Apply a predefined set of access controls to this bucket. + in: query + name: predefinedAcl + schema: + enum: + - authenticatedRead + - private + - projectPrivate + - publicRead + - publicReadWrite + type: string + - description: Apply a predefined set of default object access controls to this + bucket. + in: query + name: predefinedDefaultObjectAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Set of properties to return. Defaults to noAcl, unless the bucket + resource specifies acl or defaultObjectAcl properties, when it defaults + to full. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - buckets + /b/{bucket}: + delete: + description: Permanently deletes an empty bucket. + operationId: storage.buckets.delete + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: If set, only deletes the bucket if its metageneration matches + this value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: If set, only deletes the bucket if its metageneration does not + match this value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - buckets + get: + description: Returns metadata for the specified bucket. + operationId: storage.buckets.get + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Makes the return of the bucket metadata conditional on whether + the bucket's current metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the return of the bucket metadata conditional on whether + the bucket's current metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Set of properties to return. Defaults to noAcl. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - buckets + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches a bucket. Changes to the bucket will be readable immediately + after writing, but configuration changes may take time to propagate. + operationId: storage.buckets.patch + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Makes the return of the bucket metadata conditional on whether + the bucket's current metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the return of the bucket metadata conditional on whether + the bucket's current metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Apply a predefined set of access controls to this bucket. + in: query + name: predefinedAcl + schema: + enum: + - authenticatedRead + - private + - projectPrivate + - publicRead + - publicReadWrite + type: string + - description: Apply a predefined set of default object access controls to this + bucket. + in: query + name: predefinedDefaultObjectAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Set of properties to return. Defaults to full. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - buckets + put: + description: Updates a bucket. Changes to the bucket will be readable immediately + after writing, but configuration changes may take time to propagate. + operationId: storage.buckets.update + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Makes the return of the bucket metadata conditional on whether + the bucket's current metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the return of the bucket metadata conditional on whether + the bucket's current metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Apply a predefined set of access controls to this bucket. + in: query + name: predefinedAcl + schema: + enum: + - authenticatedRead + - private + - projectPrivate + - publicRead + - publicReadWrite + type: string + - description: Apply a predefined set of default object access controls to this + bucket. + in: query + name: predefinedDefaultObjectAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Set of properties to return. Defaults to full. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - buckets + /b/{bucket}/acl: + get: + description: Retrieves ACL entries on the specified bucket. + operationId: storage.bucketAccessControls.list + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessControls' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - bucketAccessControls + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new ACL entry on the specified bucket. + operationId: storage.bucketAccessControls.insert + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - bucketAccessControls + /b/{bucket}/acl/{entity}: + delete: + description: Permanently deletes the ACL entry for the specified entity on the + specified bucket. + operationId: storage.bucketAccessControls.delete + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - bucketAccessControls + get: + description: Returns the ACL entry for the specified entity on the specified + bucket. + operationId: storage.bucketAccessControls.get + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - bucketAccessControls + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches an ACL entry on the specified bucket. + operationId: storage.bucketAccessControls.patch + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - bucketAccessControls + put: + description: Updates an ACL entry on the specified bucket. + operationId: storage.bucketAccessControls.update + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - bucketAccessControls + /b/{bucket}/defaultObjectAcl: + get: + description: Retrieves default object ACL entries on the specified bucket. + operationId: storage.defaultObjectAccessControls.list + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: If present, only return default ACL listing if the bucket's current + metageneration matches this value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: If present, only return default ACL listing if the bucket's current + metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControls' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - defaultObjectAccessControls + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new default object ACL entry on the specified bucket. + operationId: storage.defaultObjectAccessControls.insert + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - defaultObjectAccessControls + /b/{bucket}/defaultObjectAcl/{entity}: + delete: + description: Permanently deletes the default object ACL entry for the specified + entity on the specified bucket. + operationId: storage.defaultObjectAccessControls.delete + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - defaultObjectAccessControls + get: + description: Returns the default object ACL entry for the specified entity on + the specified bucket. + operationId: storage.defaultObjectAccessControls.get + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - defaultObjectAccessControls + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches a default object ACL entry on the specified bucket. + operationId: storage.defaultObjectAccessControls.patch + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - defaultObjectAccessControls + put: + description: Updates a default object ACL entry on the specified bucket. + operationId: storage.defaultObjectAccessControls.update + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - defaultObjectAccessControls + /b/{bucket}/iam: + get: + description: Returns an IAM policy for the specified bucket. + operationId: storage.buckets.getIamPolicy + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The IAM policy format version to be returned. If the optionsRequestedPolicyVersion + is for an older version that doesn't support part of the requested IAM policy, + the request fails. + in: query + name: optionsRequestedPolicyVersion + schema: + minimum: 1 + type: integer + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - buckets + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + put: + description: Updates an IAM policy for the specified bucket. + operationId: storage.buckets.setIamPolicy + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - buckets + /b/{bucket}/iam/testPermissions: + get: + description: Tests a set of permissions on the given bucket to see which, if + any, are held by the caller. + operationId: storage.buckets.testIamPermissions + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Permissions to test. + explode: true + in: query + name: permissions + required: true + schema: + items: + type: string + type: array + style: form + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - buckets + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /b/{bucket}/lockRetentionPolicy: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Locks retention policy on a bucket. + operationId: storage.buckets.lockRetentionPolicy + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Makes the operation conditional on whether bucket's current metageneration + matches the given value. + in: query + name: ifMetagenerationMatch + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - buckets + /b/{bucket}/notificationConfigs: + get: + description: Retrieves a list of notification subscriptions for a given bucket. + operationId: storage.notifications.list + parameters: + - description: Name of a Google Cloud Storage bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Notifications' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - notifications + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a notification subscription for a given bucket. + operationId: storage.notifications.insert + parameters: + - description: The parent bucket of the notification. + in: path + name: bucket + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - notifications + /b/{bucket}/notificationConfigs/{notification}: + delete: + description: Permanently deletes a notification subscription. + operationId: storage.notifications.delete + parameters: + - description: The parent bucket of the notification. + in: path + name: bucket + required: true + schema: + type: string + - description: ID of the notification to delete. + in: path + name: notification + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - notifications + get: + description: View a notification configuration. + operationId: storage.notifications.get + parameters: + - description: The parent bucket of the notification. + in: path + name: bucket + required: true + schema: + type: string + - description: Notification ID + in: path + name: notification + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - notifications + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /b/{bucket}/o: + get: + description: Retrieves a list of objects matching the criteria. + operationId: storage.objects.list + parameters: + - description: Name of the bucket in which to look for objects. + in: path + name: bucket + required: true + schema: + type: string + - description: Returns results in a directory-like mode. items will contain + only objects whose names, aside from the prefix, do not contain delimiter. + Objects whose names, aside from the prefix, contain delimiter will have + their name, truncated after the delimiter, returned in prefixes. Duplicate + prefixes are omitted. + in: query + name: delimiter + schema: + type: string + - description: Filter results to objects whose names are lexicographically before + endOffset. If startOffset is also set, the objects listed will have names + between startOffset (inclusive) and endOffset (exclusive). + in: query + name: endOffset + schema: + type: string + - description: If true, objects that end in exactly one instance of delimiter + will have their metadata included in items in addition to prefixes. + in: query + name: includeTrailingDelimiter + schema: + type: boolean + - description: Maximum number of items plus prefixes to return in a single page + of responses. As duplicate prefixes are omitted, fewer total results may + be returned than requested. The service will use this parameter or 1,000 + items, whichever is smaller. + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - description: A previously-returned page token representing part of the larger + set of results to view. + in: query + name: pageToken + schema: + type: string + - description: Filter results to objects whose names begin with this prefix. + in: query + name: prefix + schema: + type: string + - description: Set of properties to return. Defaults to noAcl. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: Filter results to objects whose names are lexicographically equal + to or after startOffset. If endOffset is also set, the objects listed will + have names between startOffset (inclusive) and endOffset (exclusive). + in: query + name: startOffset + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + - description: If true, lists all versions of an object as distinct results. + The default is false. For more information, see Object Versioning. + in: query + name: versions + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Objects' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Stores a new object and metadata. + operationId: storage.objects.insert + parameters: + - description: Name of the bucket in which to store the new object. Overrides + the provided object metadata's bucket value, if any. + in: path + name: bucket + required: true + schema: + type: string + - description: If set, sets the contentEncoding property of the final object + to this value. Setting this parameter is equivalent to setting the contentEncoding + metadata property. This can be useful when uploading an object with uploadType=media + to indicate the encoding of the content being uploaded. + in: query + name: contentEncoding + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation matches the given value. Setting to 0 makes the operation succeed + only if there are no live versions of the object. + in: query + name: ifGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation does not match the given value. If no live object exists, the + precondition fails. Setting to 0 makes the operation succeed only if there + is a live version of the object. + in: query + name: ifGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, + that will be used to encrypt the object. Overrides the object metadata's + kms_key_name value, if any. + in: query + name: kmsKeyName + schema: + type: string + - description: Name of the object. Required when the object metadata is not + otherwise provided. Overrides the object metadata's name value, if any. + For information about how to URL encode object names to be path safe, see + Encoding URI Path Parts. + in: query + name: name + schema: + type: string + - description: Apply a predefined set of access controls to this object. + in: query + name: predefinedAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Set of properties to return. Defaults to noAcl, unless the object + resource specifies the acl property, when it defaults to full. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/Object' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + /b/{bucket}/o/watch: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Watch for changes on all objects in a bucket. + operationId: storage.objects.watchAll + parameters: + - description: Name of the bucket in which to look for objects. + in: path + name: bucket + required: true + schema: + type: string + - description: Returns results in a directory-like mode. items will contain + only objects whose names, aside from the prefix, do not contain delimiter. + Objects whose names, aside from the prefix, contain delimiter will have + their name, truncated after the delimiter, returned in prefixes. Duplicate + prefixes are omitted. + in: query + name: delimiter + schema: + type: string + - description: Filter results to objects whose names are lexicographically before + endOffset. If startOffset is also set, the objects listed will have names + between startOffset (inclusive) and endOffset (exclusive). + in: query + name: endOffset + schema: + type: string + - description: If true, objects that end in exactly one instance of delimiter + will have their metadata included in items in addition to prefixes. + in: query + name: includeTrailingDelimiter + schema: + type: boolean + - description: Maximum number of items plus prefixes to return in a single page + of responses. As duplicate prefixes are omitted, fewer total results may + be returned than requested. The service will use this parameter or 1,000 + items, whichever is smaller. + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - description: A previously-returned page token representing part of the larger + set of results to view. + in: query + name: pageToken + schema: + type: string + - description: Filter results to objects whose names begin with this prefix. + in: query + name: prefix + schema: + type: string + - description: Set of properties to return. Defaults to noAcl. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: Filter results to objects whose names are lexicographically equal + to or after startOffset. If endOffset is also set, the objects listed will + have names between startOffset (inclusive) and endOffset (exclusive). + in: query + name: startOffset + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + - description: If true, lists all versions of an object as distinct results. + The default is false. For more information, see Object Versioning. + in: query + name: versions + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + /b/{bucket}/o/{object}: + delete: + description: Deletes an object and its metadata. Deletions are permanent if + versioning is not enabled for the bucket, or if the generation parameter is + used. + operationId: storage.objects.delete + parameters: + - description: Name of the bucket in which the object resides. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: If present, permanently deletes a specific revision of this object + (as opposed to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation matches the given value. Setting to 0 makes the operation succeed + only if there are no live versions of the object. + in: query + name: ifGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation does not match the given value. If no live object exists, the + precondition fails. Setting to 0 makes the operation succeed only if there + is a live version of the object. + in: query + name: ifGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + get: + description: Retrieves an object or its metadata. + operationId: storage.objects.get + parameters: + - description: Name of the bucket in which the object resides. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation matches the given value. Setting to 0 makes the operation succeed + only if there are no live versions of the object. + in: query + name: ifGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation does not match the given value. If no live object exists, the + precondition fails. Setting to 0 makes the operation succeed only if there + is a live version of the object. + in: query + name: ifGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Set of properties to return. Defaults to noAcl. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches an object's metadata. + operationId: storage.objects.patch + parameters: + - description: Name of the bucket in which the object resides. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation matches the given value. Setting to 0 makes the operation succeed + only if there are no live versions of the object. + in: query + name: ifGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation does not match the given value. If no live object exists, the + precondition fails. Setting to 0 makes the operation succeed only if there + is a live version of the object. + in: query + name: ifGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Apply a predefined set of access controls to this object. + in: query + name: predefinedAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Set of properties to return. Defaults to full. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request, for Requester Pays + buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - objects + put: + description: Updates an object's metadata. + operationId: storage.objects.update + parameters: + - description: Name of the bucket in which the object resides. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation matches the given value. Setting to 0 makes the operation succeed + only if there are no live versions of the object. + in: query + name: ifGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation does not match the given value. If no live object exists, the + precondition fails. Setting to 0 makes the operation succeed only if there + is a live version of the object. + in: query + name: ifGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Apply a predefined set of access controls to this object. + in: query + name: predefinedAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Set of properties to return. Defaults to full. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - objects + /b/{bucket}/o/{object}/acl: + get: + description: Retrieves ACL entries on the specified object. + operationId: storage.objectAccessControls.list + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControls' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - objectAccessControls + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new ACL entry on the specified object. + operationId: storage.objectAccessControls.insert + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - objectAccessControls + /b/{bucket}/o/{object}/acl/{entity}: + delete: + description: Permanently deletes the ACL entry for the specified entity on the + specified object. + operationId: storage.objectAccessControls.delete + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - objectAccessControls + get: + description: Returns the ACL entry for the specified entity on the specified + object. + operationId: storage.objectAccessControls.get + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - objectAccessControls + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + patch: + description: Patches an ACL entry on the specified object. + operationId: storage.objectAccessControls.patch + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - objectAccessControls + put: + description: Updates an ACL entry on the specified object. + operationId: storage.objectAccessControls.update + parameters: + - description: Name of a bucket. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: The entity holding the permission. Can be user-userId, user-emailAddress, + group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + in: path + name: entity + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectAccessControl' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - objectAccessControls + /b/{bucket}/o/{object}/iam: + get: + description: Returns an IAM policy for the specified object. + operationId: storage.objects.getIamPolicy + parameters: + - description: Name of the bucket in which the object resides. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + put: + description: Updates an IAM policy for the specified object. + operationId: storage.objects.setIamPolicy + parameters: + - description: Name of the bucket in which the object resides. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + /b/{bucket}/o/{object}/iam/testPermissions: + get: + description: Tests a set of permissions on the given object to see which, if + any, are held by the caller. + operationId: storage.objects.testIamPermissions + parameters: + - description: Name of the bucket in which the object resides. + in: path + name: bucket + required: true + schema: + type: string + - description: Name of the object. For information about how to URL encode object + names to be path safe, see Encoding URI Path Parts. + in: path + name: object + required: true + schema: + type: string + - description: Permissions to test. + explode: true + in: query + name: permissions + required: true + schema: + items: + type: string + type: array + style: form + - description: If present, selects a specific revision of this object (as opposed + to the latest version, the default). + in: query + name: generation + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + /b/{destinationBucket}/o/{destinationObject}/compose: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Concatenates a list of existing objects into a new object in the + same bucket. + operationId: storage.objects.compose + parameters: + - description: Name of the bucket containing the source objects. The destination + object is stored in this bucket. + in: path + name: destinationBucket + required: true + schema: + type: string + - description: Name of the new object. For information about how to URL encode + object names to be path safe, see Encoding URI Path Parts. + in: path + name: destinationObject + required: true + schema: + type: string + - description: Apply a predefined set of access controls to the destination + object. + in: query + name: destinationPredefinedAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Makes the operation conditional on whether the object's current + generation matches the given value. Setting to 0 makes the operation succeed + only if there are no live versions of the object. + in: query + name: ifGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, + that will be used to encrypt the object. Overrides the object metadata's + kms_key_name value, if any. + in: query + name: kmsKeyName + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComposeRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + /b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Copies a source object to a destination object. Optionally overrides + metadata. + operationId: storage.objects.copy + parameters: + - description: Name of the bucket in which to find the source object. + in: path + name: sourceBucket + required: true + schema: + type: string + - description: Name of the source object. For information about how to URL encode + object names to be path safe, see Encoding URI Path Parts. + in: path + name: sourceObject + required: true + schema: + type: string + - description: Name of the bucket in which to store the new object. Overrides + the provided object metadata's bucket value, if any.For information about + how to URL encode object names to be path safe, see Encoding URI Path Parts. + in: path + name: destinationBucket + required: true + schema: + type: string + - description: Name of the new object. Required when the object metadata is + not otherwise provided. Overrides the object metadata's name value, if any. + in: path + name: destinationObject + required: true + schema: + type: string + - description: Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, + that will be used to encrypt the object. Overrides the object metadata's + kms_key_name value, if any. + in: query + name: destinationKmsKeyName + schema: + type: string + - description: Apply a predefined set of access controls to the destination + object. + in: query + name: destinationPredefinedAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Makes the operation conditional on whether the destination object's + current generation matches the given value. Setting to 0 makes the operation + succeed only if there are no live versions of the object. + in: query + name: ifGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the destination object's + current generation does not match the given value. If no live object exists, + the precondition fails. Setting to 0 makes the operation succeed only if + there is a live version of the object. + in: query + name: ifGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the destination object's + current metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the destination object's + current metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the source object's + current generation matches the given value. + in: query + name: ifSourceGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the source object's + current generation does not match the given value. + in: query + name: ifSourceGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the source object's + current metageneration matches the given value. + in: query + name: ifSourceMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the source object's + current metageneration does not match the given value. + in: query + name: ifSourceMetagenerationNotMatch + schema: + type: string + - description: Set of properties to return. Defaults to noAcl, unless the object + resource specifies the acl property, when it defaults to full. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: If present, selects a specific revision of the source object + (as opposed to the latest version, the default). + in: query + name: sourceGeneration + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + /b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Rewrites a source object to a destination object. Optionally overrides + metadata. + operationId: storage.objects.rewrite + parameters: + - description: Name of the bucket in which to find the source object. + in: path + name: sourceBucket + required: true + schema: + type: string + - description: Name of the source object. For information about how to URL encode + object names to be path safe, see Encoding URI Path Parts. + in: path + name: sourceObject + required: true + schema: + type: string + - description: Name of the bucket in which to store the new object. Overrides + the provided object metadata's bucket value, if any. + in: path + name: destinationBucket + required: true + schema: + type: string + - description: Name of the new object. Required when the object metadata is + not otherwise provided. Overrides the object metadata's name value, if any. + For information about how to URL encode object names to be path safe, see + Encoding URI Path Parts. + in: path + name: destinationObject + required: true + schema: + type: string + - description: Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, + that will be used to encrypt the object. Overrides the object metadata's + kms_key_name value, if any. + in: query + name: destinationKmsKeyName + schema: + type: string + - description: Apply a predefined set of access controls to the destination + object. + in: query + name: destinationPredefinedAcl + schema: + enum: + - authenticatedRead + - bucketOwnerFullControl + - bucketOwnerRead + - private + - projectPrivate + - publicRead + type: string + - description: Makes the operation conditional on whether the object's current + generation matches the given value. Setting to 0 makes the operation succeed + only if there are no live versions of the object. + in: query + name: ifGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the object's current + generation does not match the given value. If no live object exists, the + precondition fails. Setting to 0 makes the operation succeed only if there + is a live version of the object. + in: query + name: ifGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the destination object's + current metageneration matches the given value. + in: query + name: ifMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the destination object's + current metageneration does not match the given value. + in: query + name: ifMetagenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the source object's + current generation matches the given value. + in: query + name: ifSourceGenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the source object's + current generation does not match the given value. + in: query + name: ifSourceGenerationNotMatch + schema: + type: string + - description: Makes the operation conditional on whether the source object's + current metageneration matches the given value. + in: query + name: ifSourceMetagenerationMatch + schema: + type: string + - description: Makes the operation conditional on whether the source object's + current metageneration does not match the given value. + in: query + name: ifSourceMetagenerationNotMatch + schema: + type: string + - description: The maximum number of bytes that will be rewritten per rewrite + request. Most callers shouldn't need to specify this parameter - it is primarily + in place to support testing. If specified the value must be an integral + multiple of 1 MiB (1048576). Also, this only applies to requests where the + source and destination span locations and/or storage classes. Finally, this + value must not change across rewrite calls else you'll get an error that + the rewriteToken is invalid. + in: query + name: maxBytesRewrittenPerCall + schema: + type: string + - description: Set of properties to return. Defaults to noAcl, unless the object + resource specifies the acl property, when it defaults to full. + in: query + name: projection + schema: + enum: + - full + - noAcl + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: Include this field (from the previous rewrite response) on each + rewrite request after the first one, until the rewrite response 'done' flag + is true. Calls that provide a rewriteToken can omit all other request fields, + but if included those fields must match the values provided in the first + rewrite request. + in: query + name: rewriteToken + schema: + type: string + - description: If present, selects a specific revision of the source object + (as opposed to the latest version, the default). + in: query + name: sourceGeneration + schema: + type: string + - description: The project to be billed for this request. Required for Requester + Pays buckets. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RewriteResponse' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - objects + /channels/stop: + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Stop watching resources through this channel + operationId: storage.channels.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - channels + /projects/{projectId}/hmacKeys: + get: + description: Retrieves a list of HMAC keys matching the criteria. + operationId: storage.projects.hmacKeys.list + parameters: + - description: Name of the project in which to look for HMAC keys. + in: path + name: projectId + required: true + schema: + type: string + - description: Maximum number of items to return in a single page of responses. + The service uses this parameter or 250 items, whichever is smaller. The + max number of items per page will also be limited by the number of distinct + service accounts in the response. If the number of service accounts in a + single response is too high, the page will truncated and a next page token + will be returned. + in: query + name: maxResults + schema: + minimum: 0 + type: integer + - description: A previously-returned page token representing part of the larger + set of results to view. + in: query + name: pageToken + schema: + type: string + - description: If present, only keys for the given service account are returned. + in: query + name: serviceAccountEmail + schema: + type: string + - description: Whether or not to show keys in the DELETED state. + in: query + name: showDeletedKeys + schema: + type: boolean + - description: The project to be billed for this request. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HmacKeysMetadata' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + tags: + - projects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + post: + description: Creates a new HMAC key for the specified service account. + operationId: storage.projects.hmacKeys.create + parameters: + - description: Project ID owning the service account. + in: path + name: projectId + required: true + schema: + type: string + - description: Email address of the service account. + in: query + name: serviceAccountEmail + required: true + schema: + type: string + - description: The project to be billed for this request. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HmacKey' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - projects + /projects/{projectId}/hmacKeys/{accessId}: + delete: + description: Deletes an HMAC key. + operationId: storage.projects.hmacKeys.delete + parameters: + - description: Project ID owning the requested key + in: path + name: projectId + required: true + schema: + type: string + - description: Name of the HMAC key to be deleted. + in: path + name: accessId + required: true + schema: + type: string + - description: The project to be billed for this request. + in: query + name: userProject + schema: + type: string + responses: + '200': + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - projects + get: + description: Retrieves an HMAC key's metadata + operationId: storage.projects.hmacKeys.get + parameters: + - description: Project ID owning the service account of the requested key. + in: path + name: projectId + required: true + schema: + type: string + - description: Name of the HMAC key. + in: path + name: accessId + required: true + schema: + type: string + - description: The project to be billed for this request. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HmacKeyMetadata' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + tags: + - projects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' + put: + description: Updates the state of an HMAC key. See the HMAC Key resource descriptor + for valid states. + operationId: storage.projects.hmacKeys.update + parameters: + - description: Project ID owning the service account of the updated key. + in: path + name: projectId + required: true + schema: + type: string + - description: Name of the HMAC key being updated. + in: path + name: accessId + required: true + schema: + type: string + - description: The project to be billed for this request. + in: query + name: userProject + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HmacKeyMetadata' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HmacKeyMetadata' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + tags: + - projects + /projects/{projectId}/serviceAccount: + get: + description: Get the email address of this project's Google Cloud Storage service + account. + operationId: storage.projects.serviceAccount.get + parameters: + - description: Project ID + in: path + name: projectId + required: true + schema: + type: string + - description: The project to be billed for this request if the target bucket + is requester-pays bucket. + in: query + name: provisionalUserProject + schema: + type: string + - description: The project to be billed for this request. + in: query + name: userProject + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + description: Successful response + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_only + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_only + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + tags: + - projects + parameters: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/userIp' +servers: +- url: https://storage.googleapis.com/storage/v1 +tags: +- name: bucketAccessControls +- name: buckets +- name: channels +- name: defaultObjectAccessControls +- name: notifications +- name: objectAccessControls +- name: objects +- name: projects diff --git a/test/registry/src/googleapis.com/v1/services/storage-v1.yaml.sig b/test/registry/src/googleapis.com/v1/services/storage-v1.yaml.sig new file mode 100644 index 00000000..a44348b5 --- /dev/null +++ b/test/registry/src/googleapis.com/v1/services/storage-v1.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELiFYQ1kAKU5rzRrOWJUl6wQz1Oq5D2nc5AOFlM1T4HFTLLIzKNFue0Xotdo+gKdpCcduvya7MhyDp1plPOZ+rCxUa3b3vhDg== \ No newline at end of file diff --git a/test/registry/src/okta/v1/provider.yaml b/test/registry/src/okta/v1/provider.yaml new file mode 100644 index 00000000..4bba7b0a --- /dev/null +++ b/test/registry/src/okta/v1/provider.yaml @@ -0,0 +1,247 @@ +id: okta +name: okta +version: v1 +description: Identity Provider Services for org, user and app lifecycles +title: Okta Identity Provider +providerServices: + application: + description: Okta application + management. + id: application:v1 + name: application + preferred: true + service: + $ref: okta/v1/services/Application.yaml + title: Application API + version: v1 + authenticator: + description: Okta authenticator + management. + id: authenticator:v1 + name: authenticator + preferred: true + service: + $ref: okta/v1/services/Authenticator.yaml + title: Authenticator API + version: v1 + authorizationserver: + description: Okta authorization server + management. + id: authorizationserver:v1 + name: authorizationserver + preferred: true + service: + $ref: okta/v1/services/AuthorizationServer.yaml + title: Authorization Server API + version: v1 + domain: + description: Okta domain + management. + id: domain:v1 + name: domain + preferred: true + service: + $ref: okta/v1/services/Domain.yaml + title: Domain API + version: v1 + eventhook: + description: Okta event hook + management. + id: eventhook:v1 + name: eventhook + preferred: true + service: + $ref: okta/v1/services/EventHook.yaml + title: Event Hook API + version: v1 + feature: + description: Okta feature + management. + id: feature:v1 + name: feature + preferred: true + service: + $ref: okta/v1/services/Feature.yaml + title: Feature API + version: v1 + group: + description: Okta group + management. + id: group:v1 + name: group + preferred: true + service: + $ref: okta/v1/services/Group.yaml + title: Group API + version: v1 + groupschema: + description: Okta group schema + management. + id: groupschema:v1 + name: groupschema + preferred: true + service: + $ref: okta/v1/services/GroupSchema.yaml + title: Group Schema API + version: v1 + identityprovider: + description: Okta user + management. + id: identityprovider:v1 + name: identityprovider + preferred: true + service: + $ref: okta/v1/services/IdentityProvider.yaml + title: IDP API + version: v1 + inlinehook: + description: Okta inline hook + management. + id: inlinehook:v1 + name: inlinehook + preferred: true + service: + $ref: okta/v1/services/InlineHook.yaml + title: Inline Hook API + version: v1 + linkedobject: + description: Okta linked object + management. + id: linkedobject:v1 + name: linkedobject + preferred: true + service: + $ref: okta/v1/services/LinkedObject.yaml + title: Linked Object API + version: v1 + log: + description: Okta log + management. + id: log:v1 + name: log + preferred: true + service: + $ref: okta/v1/services/Log.yaml + title: Log API + version: v1 + networkzone: + description: Okta network zone + management. + id: networkzone:v1 + name: networkzone + preferred: true + service: + $ref: okta/v1/services/NetworkZone.yaml + title: Network Zone API + version: v1 + org: + description: Okta org + management. + id: org:v1 + name: org + preferred: true + service: + $ref: okta/v1/services/Org.yaml + title: Org API + version: v1 + policy: + description: Okta policy + management. + id: policy:v1 + name: policy + preferred: true + service: + $ref: okta/v1/services/Policy.yaml + title: Policy API + version: v1 + profilemapping: + description: Okta profile mapping + management. + id: profilemapping:v1 + name: profilemapping + preferred: true + service: + $ref: okta/v1/services/ProfileMapping.yaml + title: Profile Mapping API + version: v1 + session: + description: Okta session + management. + id: session:v1 + name: session + preferred: true + service: + $ref: okta/v1/services/Session.yaml + title: Session API + version: v1 + template: + description: Okta template + management. + id: template:v1 + name: template + preferred: true + service: + $ref: okta/v1/services/Template.yaml + title: Template API + version: v1 + threatinsight: + description: Okta threat insight + management. + id: threatinsight:v1 + name: threatinsight + preferred: true + service: + $ref: okta/v1/services/ThreatInsight.yaml + title: Threat Insight API + version: v1 + trustedorigin: + description: Okta threat insight + management. + id: trustedorigin:v1 + name: trustedorigin + preferred: true + service: + $ref: okta/v1/services/TrustedOrigin.yaml + title: Trusted Origin API + version: v1 + user: + description: Okta user + management. + id: user:v1 + name: user + preferred: true + service: + $ref: okta/v1/services/User.yaml + title: User API + version: v1 + userfactor: + description: Okta user factor + management. + id: userfactor:v1 + name: userfactor + preferred: true + service: + $ref: okta/v1/services/UserFactor.yaml + title: User Factor API + version: v1 + userschema: + description: Okta user schema + management. + id: userschema:v1 + name: userschema + preferred: true + service: + $ref: okta/v1/services/UserSchema.yaml + title: User Schema API + version: v1 + usertype: + description: Okta user type + management. + id: usertype:v1 + name: usertype + preferred: true + service: + $ref: okta/v1/services/UserType.yaml + title: User Type API + version: v1 + diff --git a/test/registry/src/okta/v1/provider.yaml.sig b/test/registry/src/okta/v1/provider.yaml.sig new file mode 100644 index 00000000..cc741662 --- /dev/null +++ b/test/registry/src/okta/v1/provider.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmI1ykkAKUKh1iAhsUYqqy3uqr6A8ckX/Enxk46jg7XOoxnR0GORZTMtMtqbujZG/t5eeOTwS4JtRpY4iQaGxctqPrxPJ6Dg== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Application.yaml b/test/registry/src/okta/v1/services/Application.yaml new file mode 100644 index 00000000..bf40ff31 --- /dev/null +++ b/test/registry/src/okta/v1/services/Application.yaml @@ -0,0 +1,2933 @@ +components: + schemas: + AcsEndpoint: + properties: + index: + type: integer + url: + type: string + type: object + x-okta-tags: + - Application + AppUser: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + credentials: + $ref: '#/components/schemas/AppUserCredentials' + externalId: + readOnly: true + type: string + id: + type: string + lastSync: + format: date-time + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + passwordChanged: + format: date-time + readOnly: true + type: string + profile: + additionalProperties: + properties: {} + type: object + type: object + scope: + type: string + status: + readOnly: true + type: string + statusChanged: + format: date-time + readOnly: true + type: string + syncState: + readOnly: true + type: string + type: object + x-okta-crud: + - alias: update + arguments: + - dest: appId + parentSrc: appId + - dest: userId + src: id + - dest: appUser + self: true + operationId: updateApplicationUser + - alias: delete + arguments: + - dest: appId + parentSrc: appId + - dest: userId + src: id + operationId: deleteApplicationUser + x-okta-tags: + - Application + AppUserCredentials: + properties: + password: + $ref: '#/components/schemas/AppUserPasswordCredential' + userName: + type: string + type: object + x-okta-tags: + - Application + AppUserPasswordCredential: + properties: + value: + format: password + type: string + type: object + x-okta-tags: + - Application + Application: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + accessibility: + $ref: '#/components/schemas/ApplicationAccessibility' + created: + format: date-time + readOnly: true + type: string + credentials: + $ref: '#/components/schemas/ApplicationCredentials' + features: + items: + type: string + type: array + id: + readOnly: true + type: string + label: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + licensing: + $ref: '#/components/schemas/ApplicationLicensing' + name: + type: string + profile: + additionalProperties: + properties: {} + type: object + type: object + settings: + $ref: '#/components/schemas/ApplicationSettings' + signOnMode: + $ref: '#/components/schemas/ApplicationSignOnMode' + status: + enum: + - ACTIVE + - INACTIVE + - DELETED + readOnly: true + type: string + visibility: + $ref: '#/components/schemas/ApplicationVisibility' + type: object + x-okta-crud: + - alias: read + arguments: + - dest: appId + src: id + operationId: getApplication + - alias: update + arguments: + - dest: appId + src: id + - dest: application + self: true + operationId: updateApplication + - alias: delete + arguments: + - dest: appId + src: id + operationId: deleteApplication + x-okta-operations: + - alias: activate + arguments: + - dest: appId + src: id + operationId: activateApplication + - alias: deactivate + arguments: + - dest: appId + src: id + operationId: deactivateApplication + - alias: listApplicationUsers + arguments: + - dest: appId + src: id + operationId: listApplicationUsers + - alias: assignUserToApplication + arguments: + - dest: appId + src: id + operationId: assignUserToApplication + - alias: getApplicationUser + arguments: + - dest: appId + src: id + operationId: getApplicationUser + - alias: createApplicationGroupAssignment + arguments: + - dest: appId + src: id + operationId: createApplicationGroupAssignment + - alias: getApplicationGroupAssignment + arguments: + - dest: appId + src: id + operationId: getApplicationGroupAssignment + - alias: cloneApplicationKey + arguments: + - dest: appId + src: id + operationId: cloneApplicationKey + - alias: getApplicationKey + arguments: + - dest: appId + src: id + operationId: getApplicationKey + - alias: listGroupAssignments + arguments: + - dest: appId + src: id + operationId: listApplicationGroupAssignments + - alias: listKeys + arguments: + - dest: appId + src: id + operationId: listApplicationKeys + - alias: generateKey + arguments: + - dest: appId + src: id + operationId: generateApplicationKey + - alias: generateCsr + arguments: + - dest: appId + src: id + operationId: generateCsrForApplication + - alias: getCsr + arguments: + - dest: appId + src: id + operationId: getCsrForApplication + - alias: revokeCsr + arguments: + - dest: appId + src: id + operationId: revokeCsrFromApplication + - alias: listCsrs + arguments: + - dest: appId + src: id + operationId: listCsrsForApplication + - alias: publishCerCert + arguments: + - dest: appId + src: id + operationId: publishCerCert + - alias: publishBinaryCerCert + arguments: + - dest: appId + src: id + operationId: publishBinaryCerCert + - alias: publishDerCert + arguments: + - dest: appId + src: id + operationId: publishDerCert + - alias: publishBinaryDerCert + arguments: + - dest: appId + src: id + operationId: publishBinaryDerCert + - alias: publishBinaryPemCert + arguments: + - dest: appId + src: id + operationId: publishBinaryPemCert + - alias: listOAuth2Tokens + arguments: + - dest: appId + src: id + operationId: listOAuth2TokensForApplication + - alias: revokeOAuth2TokenForApplication + arguments: + - dest: appId + src: id + operationId: revokeOAuth2TokenForApplication + - alias: getOAuth2Token + arguments: + - dest: appId + src: id + operationId: getOAuth2TokenForApplication + - alias: revokeOAuth2Tokens + arguments: + - dest: appId + src: id + operationId: revokeOAuth2TokensForApplication + - alias: listScopeConsentGrants + arguments: + - dest: appId + src: id + operationId: listScopeConsentGrants + - alias: grantConsentToScope + arguments: + - dest: appId + src: id + operationId: grantConsentToScope + - alias: revokeScopeConsentGrant + arguments: + - dest: appId + src: id + operationId: revokeScopeConsentGrant + - alias: getScopeConsentGrant + arguments: + - dest: appId + src: id + operationId: getScopeConsentGrant + x-okta-tags: + - Application + x-openapi-v3-discriminator: + mapping: + AUTO_LOGIN: '#/components/schemas/AutoLoginApplication' + BASIC_AUTH: '#/components/schemas/BasicAuthApplication' + BOOKMARK: '#/components/schemas/BookmarkApplication' + BROWSER_PLUGIN: '#/components/schemas/BrowserPluginApplication' + OPENID_CONNECT: '#/components/schemas/OpenIdConnectApplication' + SAML_1_1: '#/components/schemas/SamlApplication' + SAML_2_0: '#/components/schemas/SamlApplication' + SECURE_PASSWORD_STORE: '#/components/schemas/SecurePasswordStoreApplication' + WS_FEDERATION: '#/components/schemas/WsFederationApplication' + propertyName: signOnMode + ApplicationAccessibility: + properties: + errorRedirectUrl: + type: string + loginRedirectUrl: + type: string + selfService: + type: boolean + type: object + x-okta-tags: + - Application + ApplicationCredentials: + properties: + signing: + $ref: '#/components/schemas/ApplicationCredentialsSigning' + userNameTemplate: + $ref: '#/components/schemas/ApplicationCredentialsUsernameTemplate' + type: object + x-okta-tags: + - Application + ApplicationCredentialsOAuthClient: + properties: + autoKeyRotation: + type: boolean + client_id: + type: string + client_secret: + type: string + token_endpoint_auth_method: + $ref: '#/components/schemas/OAuthEndpointAuthenticationMethod' + type: object + x-okta-tags: + - Application + ApplicationCredentialsScheme: + enum: + - SHARED_USERNAME_AND_PASSWORD + - EXTERNAL_PASSWORD_SYNC + - EDIT_USERNAME_AND_PASSWORD + - EDIT_PASSWORD_ONLY + - ADMIN_SETS_CREDENTIALS + type: string + x-okta-tags: + - Application + ApplicationCredentialsSigning: + properties: + kid: + type: string + lastRotated: + format: date-time + readOnly: true + type: string + nextRotation: + format: date-time + readOnly: true + type: string + rotationMode: + type: string + use: + $ref: '#/components/schemas/ApplicationCredentialsSigningUse' + type: object + x-okta-tags: + - Application + ApplicationCredentialsSigningUse: + enum: + - sig + type: string + x-okta-tags: + - AuthorizationServer + ApplicationCredentialsUsernameTemplate: + properties: + suffix: + type: string + template: + type: string + type: + type: string + type: object + x-okta-tags: + - Application + ApplicationGroupAssignment: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + priority: + type: integer + profile: + additionalProperties: + properties: {} + type: object + type: object + type: object + x-okta-crud: + - alias: delete + arguments: + - dest: appId + parentSrc: appId + - dest: groupId + src: id + operationId: deleteApplicationGroupAssignment + x-okta-tags: + - Application + ApplicationLicensing: + properties: + seatCount: + type: integer + type: object + x-okta-tags: + - Application + ApplicationSettings: + properties: + app: + $ref: '#/components/schemas/ApplicationSettingsApplication' + implicitAssignment: + type: boolean + inlineHookId: + type: string + notes: + $ref: '#/components/schemas/ApplicationSettingsNotes' + notifications: + $ref: '#/components/schemas/ApplicationSettingsNotifications' + type: object + x-okta-tags: + - Application + ApplicationSettingsApplication: + type: object + x-okta-tags: + - Application + ApplicationSettingsNotes: + properties: + admin: + type: string + enduser: + type: string + type: object + x-okta-tags: + - Application + ApplicationSettingsNotifications: + properties: + vpn: + $ref: '#/components/schemas/ApplicationSettingsNotificationsVpn' + type: object + x-okta-tags: + - Application + ApplicationSettingsNotificationsVpn: + properties: + helpUrl: + type: string + message: + type: string + network: + $ref: '#/components/schemas/ApplicationSettingsNotificationsVpnNetwork' + type: object + x-okta-tags: + - Application + ApplicationSettingsNotificationsVpnNetwork: + properties: + connection: + type: string + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + ApplicationSignOnMode: + enum: + - BOOKMARK + - BASIC_AUTH + - BROWSER_PLUGIN + - SECURE_PASSWORD_STORE + - AUTO_LOGIN + - WS_FEDERATION + - SAML_2_0 + - OPENID_CONNECT + - SAML_1_1 + type: string + x-okta-tags: + - Application + ApplicationVisibility: + properties: + appLinks: + additionalProperties: + type: boolean + type: object + autoLaunch: + type: boolean + autoSubmitToolbar: + type: boolean + hide: + $ref: '#/components/schemas/ApplicationVisibilityHide' + type: object + x-okta-tags: + - Application + ApplicationVisibilityHide: + properties: + iOS: + type: boolean + web: + type: boolean + type: object + x-okta-tags: + - Application + AuthorizationServerCredentials: + properties: + signing: + $ref: '#/components/schemas/AuthorizationServerCredentialsSigningConfig' + type: object + x-okta-tags: + - Application + AuthorizationServerCredentialsRotationMode: + enum: + - AUTO + - MANUAL + type: string + x-okta-tags: + - AuthorizationServer + AuthorizationServerCredentialsSigningConfig: + properties: + kid: + type: string + lastRotated: + format: date-time + readOnly: true + type: string + nextRotation: + format: date-time + readOnly: true + type: string + rotationMode: + $ref: '#/components/schemas/AuthorizationServerCredentialsRotationMode' + use: + $ref: '#/components/schemas/AuthorizationServerCredentialsUse' + type: object + x-okta-tags: + - AuthorizationServer + AuthorizationServerCredentialsUse: + enum: + - sig + type: string + x-okta-tags: + - AuthorizationServer + AutoLoginApplication: + properties: + credentials: + $ref: '#/components/schemas/SchemeApplicationCredentials' + settings: + $ref: '#/components/schemas/AutoLoginApplicationSettings' + type: object + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + AutoLoginApplicationSettings: + properties: + signOn: + $ref: '#/components/schemas/AutoLoginApplicationSettingsSignOn' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + AutoLoginApplicationSettingsSignOn: + properties: + loginUrl: + type: string + redirectUrl: + type: string + type: object + x-okta-tags: + - Application + BasicApplicationSettings: + properties: + app: + $ref: '#/components/schemas/BasicApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + BasicApplicationSettingsApplication: + properties: + authURL: + type: string + url: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + BasicAuthApplication: + properties: + credentials: + $ref: '#/components/schemas/SchemeApplicationCredentials' + name: + type: object + settings: + $ref: '#/components/schemas/BasicApplicationSettings' + type: object + x-okta-defined-as: + name: template_basic_auth + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + BookmarkApplication: + properties: + name: + type: object + settings: + $ref: '#/components/schemas/BookmarkApplicationSettings' + type: object + x-okta-defined-as: + name: bookmark + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + BookmarkApplicationSettings: + properties: + app: + $ref: '#/components/schemas/BookmarkApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + BookmarkApplicationSettingsApplication: + properties: + requestIntegration: + type: boolean + url: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + BrowserPluginApplication: + properties: + credentials: + $ref: '#/components/schemas/SchemeApplicationCredentials' + type: object + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + x-openapi-v3-discriminator: + mapping: + template_swa: '#/components/schemas/SwaApplication' + template_swa3field: '#/components/schemas/SwaThreeFieldApplication' + propertyName: name + Csr: + properties: + created: + format: date-time + readOnly: true + type: string + csr: + readOnly: true + type: string + id: + readOnly: true + type: string + kty: + readOnly: true + type: string + type: object + x-okta-tags: + - Application + CsrMetadata: + properties: + subject: + $ref: '#/components/schemas/CsrMetadataSubject' + subjectAltNames: + $ref: '#/components/schemas/CsrMetadataSubjectAltNames' + type: object + x-okta-tags: + - Application + CsrMetadataSubject: + properties: + commonName: + type: string + countryName: + type: string + localityName: + type: string + organizationName: + type: string + organizationalUnitName: + type: string + stateOrProvinceName: + type: string + type: object + x-okta-tags: + - Application + CsrMetadataSubjectAltNames: + properties: + dnsNames: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + JsonWebKey: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + alg: + type: string + created: + format: date-time + type: string + e: + type: string + expiresAt: + format: date-time + type: string + key_ops: + items: + type: string + type: array + kid: + type: string + kty: + type: string + lastUpdated: + format: date-time + type: string + n: + type: string + status: + type: string + use: + type: string + x5c: + items: + type: string + type: array + x5t: + type: string + x5t#S256: + type: string + x5u: + type: string + type: object + x-okta-tags: + - Application + JwkUse: + properties: + use: + enum: + - sig + type: string + type: object + x-okta-tags: + - Application + OAuth2Actor: + properties: + id: + readOnly: true + type: string + type: + type: string + type: object + x-okta-tags: + - Application + OAuth2Claim: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + alwaysIncludeInToken: + type: boolean + claimType: + enum: + - IDENTITY + - RESOURCE + type: string + conditions: + $ref: '#/components/schemas/OAuth2ClaimConditions' + group_filter_type: + enum: + - STARTS_WITH + - EQUALS + - CONTAINS + - REGEX + type: string + id: + readOnly: true + type: string + name: + type: string + status: + enum: + - ACTIVE + - INACTIVE + type: string + system: + type: boolean + value: + type: string + valueType: + enum: + - EXPRESSION + - GROUPS + - SYSTEM + type: string + type: object + x-okta-tags: + - Application + OAuth2ClaimConditions: + properties: + scopes: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + OAuth2Client: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + client_id: + readOnly: true + type: string + client_name: + readOnly: true + type: string + client_uri: + readOnly: true + type: string + logo_uri: + readOnly: true + type: string + type: object + x-okta-tags: + - Application + OAuth2RefreshToken: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + clientId: + type: string + created: + format: date-time + readOnly: true + type: string + createdBy: + $ref: '#/components/schemas/OAuth2Actor' + expiresAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + issuer: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + scopes: + items: + type: string + type: array + status: + enum: + - ACTIVE + - REVOKED + type: string + userId: + type: string + type: object + x-okta-tags: + - Application + OAuth2Scope: + properties: + consent: + enum: + - REQUIRED + - IMPLICIT + - ADMIN + type: string + default: + type: boolean + description: + type: string + displayName: + type: string + id: + readOnly: true + type: string + metadataPublish: + enum: + - ALL_CLIENTS + - NO_CLIENTS + type: string + name: + type: string + system: + type: boolean + type: object + x-okta-tags: + - Application + OAuth2ScopeConsentGrant: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + clientId: + type: string + created: + format: date-time + readOnly: true + type: string + createdBy: + $ref: '#/components/schemas/OAuth2Actor' + id: + readOnly: true + type: string + issuer: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + scopeId: + type: string + source: + $ref: '#/components/schemas/OAuth2ScopeConsentGrantSource' + status: + $ref: '#/components/schemas/OAuth2ScopeConsentGrantStatus' + userId: + type: string + type: object + x-okta-tags: + - Application + OAuth2ScopeConsentGrantSource: + enum: + - END_USER + - ADMIN + type: string + x-okta-tags: + - Application + OAuth2ScopeConsentGrantStatus: + enum: + - ACTIVE + - REVOKED + type: string + x-okta-tags: + - Application + OAuth2ScopesMediationPolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + OAuth2Token: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + clientId: + type: string + created: + format: date-time + readOnly: true + type: string + expiresAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + issuer: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + scopes: + items: + type: string + type: array + status: + enum: + - ACTIVE + - REVOKED + type: string + userId: + type: string + type: object + x-okta-tags: + - Application + OAuthApplicationCredentials: + properties: + oauthClient: + $ref: '#/components/schemas/ApplicationCredentialsOAuthClient' + type: object + x-okta-parent: '#/components/schemas/ApplicationCredentials' + x-okta-tags: + - Application + OAuthEndpointAuthenticationMethod: + enum: + - none + - client_secret_post + - client_secret_basic + - client_secret_jwt + - private_key_jwt + type: string + x-okta-tags: + - Application + OAuthGrantType: + enum: + - authorization_code + - implicit + - password + - refresh_token + - client_credentials + type: string + x-okta-tags: + - Application + OAuthResponseType: + enum: + - code + - token + - id_token + type: string + x-okta-tags: + - Application + OpenIdConnectApplication: + properties: + credentials: + $ref: '#/components/schemas/OAuthApplicationCredentials' + name: + type: object + settings: + $ref: '#/components/schemas/OpenIdConnectApplicationSettings' + type: object + x-okta-defined-as: + name: oidc_client + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + OpenIdConnectApplicationConsentMethod: + enum: + - REQUIRED + - TRUSTED + type: string + x-okta-tags: + - Application + OpenIdConnectApplicationIdpInitiatedLogin: + properties: + default_scope: + items: + type: string + type: array + mode: + type: string + type: object + x-okta-tags: + - Application + OpenIdConnectApplicationIssuerMode: + enum: + - CUSTOM_URL + - ORG_URL + type: string + x-okta-tags: + - Application + OpenIdConnectApplicationSettings: + properties: + oauthClient: + $ref: '#/components/schemas/OpenIdConnectApplicationSettingsClient' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + OpenIdConnectApplicationSettingsClient: + properties: + application_type: + $ref: '#/components/schemas/OpenIdConnectApplicationType' + client_uri: + type: string + consent_method: + $ref: '#/components/schemas/OpenIdConnectApplicationConsentMethod' + grant_types: + items: + $ref: '#/components/schemas/OAuthGrantType' + type: array + idp_initiated_login: + $ref: '#/components/schemas/OpenIdConnectApplicationIdpInitiatedLogin' + initiate_login_uri: + type: string + issuer_mode: + $ref: '#/components/schemas/OpenIdConnectApplicationIssuerMode' + jwks: + $ref: '#/components/schemas/OpenIdConnectApplicationSettingsClientKeys' + logo_uri: + type: string + policy_uri: + type: string + post_logout_redirect_uris: + items: + type: string + type: array + redirect_uris: + items: + type: string + type: array + refresh_token: + $ref: '#/components/schemas/OpenIdConnectApplicationSettingsRefreshToken' + response_types: + items: + $ref: '#/components/schemas/OAuthResponseType' + type: array + tos_uri: + type: string + wildcard_redirect: + type: string + type: object + x-okta-tags: + - Application + OpenIdConnectApplicationSettingsClientKeys: + properties: + keys: + items: + $ref: '#/components/schemas/JsonWebKey' + type: array + type: object + x-okta-tags: + - Application + OpenIdConnectApplicationSettingsRefreshToken: + properties: + leeway: + type: integer + rotation_type: + $ref: '#/components/schemas/OpenIdConnectRefreshTokenRotationType' + type: object + x-okta-tags: + - Application + OpenIdConnectApplicationType: + enum: + - web + - native + - browser + - service + type: string + x-okta-tags: + - Application + OpenIdConnectRefreshTokenRotationType: + enum: + - rotate + - static + type: string + x-okta-tags: + - Application + PasswordCredential: + properties: + hash: + $ref: '#/components/schemas/PasswordCredentialHash' + hook: + $ref: '#/components/schemas/PasswordCredentialHook' + value: + format: password + type: string + type: object + x-okta-tags: + - User + PasswordCredentialHash: + properties: + algorithm: + $ref: '#/components/schemas/PasswordCredentialHashAlgorithm' + salt: + type: string + saltOrder: + type: string + value: + type: string + workFactor: + type: integer + type: object + x-okta-tags: + - User + PasswordCredentialHashAlgorithm: + enum: + - BCRYPT + - SHA-512 + - SHA-256 + - SHA-1 + - MD5 + type: string + x-okta-tags: + - User + PasswordCredentialHook: + properties: + type: + type: string + type: object + x-okta-tags: + - User + SamlApplication: + properties: + settings: + $ref: '#/components/schemas/SamlApplicationSettings' + type: object + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + SamlApplicationSettings: + properties: + signOn: + $ref: '#/components/schemas/SamlApplicationSettingsSignOn' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + SamlApplicationSettingsSignOn: + properties: + acsEndpoints: + items: + $ref: '#/components/schemas/AcsEndpoint' + type: array + allowMultipleAcsEndpoints: + type: boolean + assertionSigned: + type: boolean + attributeStatements: + items: + $ref: '#/components/schemas/SamlAttributeStatement' + type: array + audience: + type: string + audienceOverride: + type: string + authnContextClassRef: + type: string + defaultRelayState: + type: string + destination: + type: string + destinationOverride: + type: string + digestAlgorithm: + type: string + honorForceAuthn: + type: boolean + idpIssuer: + type: string + inlineHooks: + items: + $ref: '#/components/schemas/SignOnInlineHook' + type: array + recipient: + type: string + recipientOverride: + type: string + requestCompressed: + type: boolean + responseSigned: + type: boolean + signatureAlgorithm: + type: string + slo: + $ref: '#/components/schemas/SingleLogout' + spCertificate: + $ref: '#/components/schemas/SpCertificate' + spIssuer: + type: string + ssoAcsUrl: + type: string + ssoAcsUrlOverride: + type: string + subjectNameIdFormat: + type: string + subjectNameIdTemplate: + type: string + type: object + x-okta-tags: + - Application + SamlAttributeStatement: + properties: + filterType: + type: string + filterValue: + type: string + name: + type: string + namespace: + type: string + type: + type: string + values: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + SchemeApplicationCredentials: + properties: + password: + $ref: '#/components/schemas/PasswordCredential' + revealPassword: + type: boolean + scheme: + $ref: '#/components/schemas/ApplicationCredentialsScheme' + signing: + $ref: '#/components/schemas/ApplicationCredentialsSigning' + userName: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationCredentials' + x-okta-tags: + - Application + SecurePasswordStoreApplication: + properties: + credentials: + $ref: '#/components/schemas/SchemeApplicationCredentials' + name: + type: object + settings: + $ref: '#/components/schemas/SecurePasswordStoreApplicationSettings' + type: object + x-okta-defined-as: + name: template_sps + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + SecurePasswordStoreApplicationSettings: + properties: + app: + $ref: '#/components/schemas/SecurePasswordStoreApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + SecurePasswordStoreApplicationSettingsApplication: + properties: + optionalField1: + type: string + optionalField1Value: + type: string + optionalField2: + type: string + optionalField2Value: + type: string + optionalField3: + type: string + optionalField3Value: + type: string + passwordField: + type: string + url: + type: string + usernameField: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + SignOnInlineHook: + properties: + id: + type: string + type: object + x-okta-tags: + - Application + SingleLogout: + properties: + enabled: + type: boolean + issuer: + type: string + logoutUrl: + type: string + type: object + x-okta-tags: + - Application + SpCertificate: + properties: + x5c: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + SwaApplication: + properties: + name: + type: object + settings: + $ref: '#/components/schemas/SwaApplicationSettings' + type: object + x-okta-defined-as: + name: template_swa + x-okta-parent: '#/components/schemas/BrowserPluginApplication' + x-okta-tags: + - Application + SwaApplicationSettings: + properties: + app: + $ref: '#/components/schemas/SwaApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + SwaApplicationSettingsApplication: + properties: + buttonField: + type: string + loginUrlRegex: + type: string + passwordField: + type: string + url: + type: string + usernameField: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + SwaThreeFieldApplication: + properties: + name: + type: object + settings: + $ref: '#/components/schemas/SwaThreeFieldApplicationSettings' + type: object + x-okta-defined-as: + name: template_swa3field + x-okta-parent: '#/components/schemas/BrowserPluginApplication' + x-okta-tags: + - Application + SwaThreeFieldApplicationSettings: + properties: + app: + $ref: '#/components/schemas/SwaThreeFieldApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + SwaThreeFieldApplicationSettingsApplication: + properties: + buttonSelector: + type: string + extraFieldSelector: + type: string + extraFieldValue: + type: string + loginUrlRegex: + type: string + passwordSelector: + type: string + targetURL: + type: string + userNameSelector: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + WsFederationApplication: + properties: + name: + type: object + settings: + $ref: '#/components/schemas/WsFederationApplicationSettings' + type: object + x-okta-defined-as: + name: template_wsfed + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + WsFederationApplicationSettings: + properties: + app: + $ref: '#/components/schemas/WsFederationApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + WsFederationApplicationSettingsApplication: + properties: + attributeStatements: + type: string + audienceRestriction: + type: string + authnContextClassRef: + type: string + groupFilter: + type: string + groupName: + type: string + groupValueFormat: + type: string + nameIDFormat: + type: string + realm: + type: string + siteURL: + type: string + usernameAttribute: + type: string + wReplyOverride: + type: boolean + wReplyURL: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + apps: + id: okta.application.apps + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/apps/{appId}/lifecycle/activate + response: + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/apps/{appId}/lifecycle/deactivate + response: + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/apps/{appId} + response: + openAPIDocKey: '200' + deleteall: + operation: + $ref: DELETE + path: + $ref: /api/v1/apps/{appId}/tokens + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/apps + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/apps + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/apps/{appId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: apps + title: apps + csrs: + id: okta.application.csrs + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/apps/{appId}/credentials/csrs/{csrId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/credentials/csrs/{csrId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/apps/{appId}/credentials/csrs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '201' + list: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/credentials/csrs + response: + mediaType: application/json + openAPIDocKey: '200' + name: csrs + title: csrs + grants: + id: okta.application.grants + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/apps/{appId}/grants/{grantId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/grants/{grantId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/apps/{appId}/grants + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '201' + list: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/grants + response: + mediaType: application/json + openAPIDocKey: '200' + name: grants + title: grants + groups: + id: okta.application.groups + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/apps/{appId}/groups/{groupId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/groups/{groupId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/groups + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/apps/{appId}/groups/{groupId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: groups + title: groups + keys: + id: okta.application.keys + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/apps/{appId}/credentials/csrs/{csrId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/credentials/keys/{keyId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/apps/{appId}/credentials/keys/generate + response: + mediaType: application/json + openAPIDocKey: '201' + list: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/credentials/keys + response: + mediaType: application/json + openAPIDocKey: '200' + name: keys + title: keys + tokens: + id: okta.application.tokens + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/apps/{appId}/tokens/{tokenId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/tokens/{tokenId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/tokens + response: + mediaType: application/json + openAPIDocKey: '200' + name: tokens + title: tokens + users: + id: okta.application.users + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/apps/{appId}/users/{userId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/users/{userId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/apps/{appId}/users + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/apps/{appId}/users + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: POST + path: + $ref: /api/v1/apps/{appId}/users/{userId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: users + title: users +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 + x-serviceName: application +openapi: 3.0.1 +paths: + /api/v1/apps: + get: + description: Enumerates apps added to your organization with pagination. A subset + of apps can be returned that match a supported filter expression or query. + operationId: listApplications + parameters: + - in: query + name: q + schema: + type: string + - description: Specifies the pagination cursor for the next page of apps + in: query + name: after + schema: + type: string + - description: Specifies the number of results for a page + in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + - description: Filters apps by status, user.id, group.id or credentials.signing.kid + expression + in: query + name: filter + schema: + type: string + - description: Traverses users link relationship and optionally embeds Application + User resource + in: query + name: expand + schema: + type: string + - in: query + name: includeNonDeleted + schema: + default: false + type: boolean + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Application' + type: array + description: Success + security: + - api_token: [] + summary: List Applications + tags: + - Application + post: + description: Adds a new application to your Okta organization. + operationId: createApplication + parameters: + - description: Executes activation lifecycle operation when creating the app + in: query + name: activate + schema: + default: true + type: boolean + - in: header + name: OktaAccessGateway-Agent + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + description: Success + security: + - api_token: [] + summary: Add Application + tags: + - Application + x-codegen-request-body-name: application + /api/v1/apps/{appId}: + delete: + description: Removes an inactive application. + operationId: deleteApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + summary: Delete Application + tags: + - Application + get: + description: Fetches an application from your Okta organization by `id`. + operationId: getApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + description: Success + security: + - api_token: [] + summary: Get Application + tags: + - Application + put: + description: Updates an application in your organization. + operationId: updateApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + description: Success + security: + - api_token: [] + summary: Update Application + tags: + - Application + x-codegen-request-body-name: application + /api/v1/apps/{appId}/credentials/csrs: + get: + description: Enumerates Certificate Signing Requests for an application + operationId: listCsrsForApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Csr' + type: array + description: Success + security: + - api_token: [] + summary: List Certificate Signing Requests for Application + tags: + - Application + post: + description: Generates a new key pair and returns the Certificate Signing Request + for it. + operationId: generateCsrForApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CsrMetadata' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Csr' + description: Created + security: + - api_token: [] + summary: Generate Certificate Signing Request for Application + tags: + - Application + x-codegen-request-body-name: metadata + /api/v1/apps/{appId}/credentials/csrs/{csrId}: + delete: + operationId: revokeCsrFromApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: csrId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Application + get: + operationId: getCsrForApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: csrId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Csr' + description: Success + security: + - api_token: [] + tags: + - Application + /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish: + post: + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: csrId + required: true + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Created + security: + - api_token: [] + tags: + - Application + x-okta-multi-operation: + - consumes: + - application/x-x509-ca-cert + encoding: base64 + operationId: publishCerCert + parameters: + - in: body + name: certificate + required: true + type: string + - consumes: + - application/x-x509-ca-cert + operationId: publishBinaryCerCert + parameters: + - format: binary + in: body + name: certificate + required: true + type: string + - consumes: + - application/pkix-cert + encoding: base64 + operationId: publishDerCert + parameters: + - in: body + name: certificate + required: true + type: string + - consumes: + - application/pkix-cert + operationId: publishBinaryDerCert + parameters: + - format: binary + in: body + name: certificate + required: true + type: string + - consumes: + - application/x-pem-file + operationId: publishBinaryPemCert + parameters: + - format: binary + in: body + name: certificate + required: true + type: string + /api/v1/apps/{appId}/credentials/keys: + get: + description: Enumerates key credentials for an application + operationId: listApplicationKeys + parameters: + - in: path + name: appId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/JsonWebKey' + type: array + description: Success + security: + - api_token: [] + summary: List Key Credentials for Application + tags: + - Application + /api/v1/apps/{appId}/credentials/keys/generate: + post: + description: Generates a new X.509 certificate for an application key credential + operationId: generateApplicationKey + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: query + name: validityYears + schema: + type: integer + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Created + security: + - api_token: [] + tags: + - Application + /api/v1/apps/{appId}/credentials/keys/{keyId}: + get: + description: Gets a specific application key credential by kid + operationId: getApplicationKey + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: keyId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Success + security: + - api_token: [] + summary: Get Key Credential for Application + tags: + - Application + /api/v1/apps/{appId}/credentials/keys/{keyId}/clone: + post: + description: Clones a X.509 certificate for an application key credential from + a source application to target application. + operationId: cloneApplicationKey + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: keyId + required: true + schema: + type: string + - description: Unique key of the target Application + in: query + name: targetAid + required: true + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Created + security: + - api_token: [] + summary: Clone Application Key Credential + tags: + - Application + /api/v1/apps/{appId}/grants: + get: + description: Lists all scope consent grants for the application + operationId: listScopeConsentGrants + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2ScopeConsentGrant' + type: array + description: Success + security: + - api_token: [] + tags: + - Application + post: + description: Grants consent for the application to request an OAuth 2.0 Okta + scope + operationId: grantConsentToScope + parameters: + - in: path + name: appId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2ScopeConsentGrant' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2ScopeConsentGrant' + description: Created + security: + - api_token: [] + tags: + - Application + x-codegen-request-body-name: oAuth2ScopeConsentGrant + /api/v1/apps/{appId}/grants/{grantId}: + delete: + description: Revokes permission for the application to request the given scope + operationId: revokeScopeConsentGrant + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: grantId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Application + get: + description: Fetches a single scope consent grant for the application + operationId: getScopeConsentGrant + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: grantId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2ScopeConsentGrant' + description: Success + security: + - api_token: [] + tags: + - Application + /api/v1/apps/{appId}/groups: + get: + description: Enumerates group assignments for an application. + operationId: listApplicationGroupAssignments + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: query + name: q + schema: + type: string + - description: Specifies the pagination cursor for the next page of assignments + in: query + name: after + schema: + type: string + - description: Specifies the number of results for a page + in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApplicationGroupAssignment' + type: array + description: Success + security: + - api_token: [] + summary: List Groups Assigned to Application + tags: + - Application + /api/v1/apps/{appId}/groups/{groupId}: + delete: + description: Removes a group assignment from an application. + operationId: deleteApplicationGroupAssignment + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: groupId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Remove Group from Application + tags: + - Application + get: + description: Fetches an application group assignment + operationId: getApplicationGroupAssignment + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: groupId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationGroupAssignment' + description: Success + security: + - api_token: [] + summary: Get Assigned Group for Application + tags: + - Application + put: + description: Assigns a group to an application + operationId: createApplicationGroupAssignment + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: groupId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationGroupAssignment' + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationGroupAssignment' + description: Success + security: + - api_token: [] + summary: Assign Group to Application + tags: + - Application + x-codegen-request-body-name: applicationGroupAssignment + /api/v1/apps/{appId}/lifecycle/activate: + post: + description: Activates an inactive application. + operationId: activateApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + summary: Activate Application + tags: + - Application + /api/v1/apps/{appId}/lifecycle/deactivate: + post: + description: Deactivates an active application. + operationId: deactivateApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + summary: Deactivate Application + tags: + - Application + /api/v1/apps/{appId}/tokens: + delete: + description: Revokes all tokens for the specified application + operationId: revokeOAuth2TokensForApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Application + get: + description: Lists all tokens for the application + operationId: listOAuth2TokensForApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2Token' + type: array + description: Success + security: + - api_token: [] + tags: + - Application + /api/v1/apps/{appId}/tokens/{tokenId}: + delete: + description: Revokes the specified token for the specified application + operationId: revokeOAuth2TokenForApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: tokenId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Application + get: + description: Gets a token for the specified application + operationId: getOAuth2TokenForApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: tokenId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Token' + description: Success + security: + - api_token: [] + tags: + - Application + /api/v1/apps/{appId}/users: + get: + description: Enumerates all assigned [application users](#application-user-model) + for an application. + operationId: listApplicationUsers + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: query_scope + schema: + type: string + - description: specifies the pagination cursor for the next page of assignments + in: query + name: after + schema: + type: string + - description: specifies the number of results for a page + in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + - in: query + name: filter + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AppUser' + type: array + description: Success + security: + - api_token: [] + summary: List Users Assigned to Application + tags: + - Application + post: + description: Assigns an user to an application with [credentials](#application-user-credentials-object) + and an app-specific [profile](#application-user-profile-object). Profile mappings + defined for the application are first applied before applying any profile + properties specified in the request. + operationId: assignUserToApplication + parameters: + - in: path + name: appId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppUser' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppUser' + description: Success + security: + - api_token: [] + summary: Assign User to Application for SSO & Provisioning + tags: + - Application + x-codegen-request-body-name: appUser + /api/v1/apps/{appId}/users/{userId}: + delete: + description: Removes an assignment for a user from an application. + operationId: deleteApplicationUser + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: sendEmail + schema: + default: false + type: boolean + x-okta-added-version: 1.5.0 + x-okta-added-version: 1.5.0 + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Remove User from Application + tags: + - Application + get: + description: Fetches a specific user assignment for application by `id`. + operationId: getApplicationUser + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppUser' + description: Success + security: + - api_token: [] + summary: Get Assigned User for Application + tags: + - Application + post: + description: Updates a user's profile for an application + operationId: updateApplicationUser + parameters: + - in: path + name: appId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppUser' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppUser' + description: Success + security: + - api_token: [] + summary: Update Application Profile for Assigned User + tags: + - Application + x-codegen-request-body-name: appUser +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Application.yaml.sig b/test/registry/src/okta/v1/services/Application.yaml.sig new file mode 100644 index 00000000..5794b0e1 --- /dev/null +++ b/test/registry/src/okta/v1/services/Application.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELoAXKHeAKUerb88vHGvEZ7Am+lg/6mZieSbn4up4LXpIVi64q0iQIp8Fgnsu1Zncdo+ndTPVeXv+BURvdKV/NTWrkZkNo7Ag== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Authenticator.yaml b/test/registry/src/okta/v1/services/Authenticator.yaml new file mode 100644 index 00000000..f2f66058 --- /dev/null +++ b/test/registry/src/okta/v1/services/Authenticator.yaml @@ -0,0 +1,228 @@ +components: + schemas: + AllowedForEnum: + enum: + - recovery + - sso + - any + - none + type: string + x-okta-tags: + - Authenticator + Authenticator: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + key: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + settings: + $ref: '#/components/schemas/AuthenticatorSettings' + status: + $ref: '#/components/schemas/AuthenticatorStatus' + type: + $ref: '#/components/schemas/AuthenticatorType' + type: object + x-okta-operations: + - alias: activate + arguments: + - dest: authenticatorId + src: id + operationId: activateAuthenticator + - alias: deactivate + arguments: + - dest: authenticatorId + src: id + operationId: deactivateAuthenticator + x-okta-tags: + - Authenticator + AuthenticatorSettings: + properties: + allowedFor: + $ref: '#/components/schemas/AllowedForEnum' + tokenLifetimeInMinutes: + type: integer + type: object + x-okta-tags: + - Authenticator + AuthenticatorStatus: + enum: + - ACTIVE + - INACTIVE + type: string + x-okta-tags: + - Authenticator + AuthenticatorType: + enum: + - app + - password + - security_question + - phone + - email + - security_key + - federated + type: string + x-okta-tags: + - Authenticator + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + authenticators: + id: okta.authenticator.authenticators + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/authenticators/{authenticatorId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: GET + path: + $ref: /api/v1/authenticators/{authenticatorId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/authenticators + response: + mediaType: application/json + openAPIDocKey: '200' + name: authenticators + title: authenticators +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/authenticators: + get: + description: Success + operationId: listAuthenticators + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Authenticator' + type: array + description: Success + security: + - api_token: [] + tags: + - Authenticator + /api/v1/authenticators/{authenticatorId}: + get: + description: Success + operationId: getAuthenticator + parameters: + - in: path + name: authenticatorId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authenticator' + description: Success + security: + - api_token: [] + tags: + - Authenticator + /api/v1/authenticators/{authenticatorId}/lifecycle/activate: + post: + description: Success + operationId: activateAuthenticator + parameters: + - in: path + name: authenticatorId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authenticator' + description: Success + security: + - api_token: [] + tags: + - Authenticator + /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate: + post: + description: Success + operationId: deactivateAuthenticator + parameters: + - in: path + name: authenticatorId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Authenticator' + description: Success + security: + - api_token: [] + tags: + - Authenticator +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Authenticator.yaml.sig b/test/registry/src/okta/v1/services/Authenticator.yaml.sig new file mode 100644 index 00000000..978bb55c --- /dev/null +++ b/test/registry/src/okta/v1/services/Authenticator.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnD8iecAKUMFWcv+7L7q5axpcuWE19tmdF5x0HzcRFejhNi/I6UVvSlorruQai8Nyj3KcXUrVkPFIlN6Oe6q6VVa52Xmk/AQ== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/AuthorizationServer.yaml b/test/registry/src/okta/v1/services/AuthorizationServer.yaml new file mode 100644 index 00000000..9aa8763a --- /dev/null +++ b/test/registry/src/okta/v1/services/AuthorizationServer.yaml @@ -0,0 +1,2582 @@ +components: + schemas: + AppAndInstanceConditionEvaluatorAppOrInstance: + properties: + id: + readOnly: true + type: string + name: + type: string + type: + enum: + - APP_TYPE + - APP + type: string + type: object + x-okta-tags: + - Policy + AppAndInstancePolicyRuleCondition: + properties: + exclude: + items: + $ref: '#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance' + type: array + include: + items: + $ref: '#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance' + type: array + type: object + x-okta-tags: + - Policy + AppInstancePolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + ApplicationCredentialsSigningUse: + enum: + - sig + type: string + x-okta-tags: + - AuthorizationServer + AuthorizationServer: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + audiences: + items: + type: string + type: array + created: + format: date-time + readOnly: true + type: string + credentials: + $ref: '#/components/schemas/AuthorizationServerCredentials' + description: + type: string + id: + readOnly: true + type: string + issuer: + type: string + issuerMode: + enum: + - ORG_URL + - CUSTOM_URL + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + status: + enum: + - ACTIVE + - INACTIVE + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: authorizationServer + self: true + operationId: createAuthorizationServer + - alias: read + arguments: [] + operationId: getAuthorizationServer + - alias: update + arguments: + - dest: authServerId + src: id + - dest: authorizationServer + self: true + operationId: updateAuthorizationServer + - alias: delete + arguments: + - dest: authServerId + src: id + - dest: authorizationServer + self: true + operationId: deleteAuthorizationServer + x-okta-operations: + - alias: listOAuth2Claims + arguments: + - dest: authServerId + src: id + operationId: listOAuth2Claims + - alias: createOAuth2Claim + arguments: + - dest: authServerId + src: id + operationId: createOAuth2Claim + - alias: deleteOAuth2Claim + arguments: + - dest: authServerId + src: id + operationId: deleteOAuth2Claim + - alias: getOAuth2Claim + arguments: + - dest: authServerId + src: id + operationId: getOAuth2Claim + - alias: updateOAuth2Claim + arguments: + - dest: authServerId + src: id + operationId: updateOAuth2Claim + - alias: listOAuth2Clients + arguments: + - dest: authServerId + src: id + operationId: listOAuth2ClientsForAuthorizationServer + - alias: revokeRefreshTokensForClient + arguments: + - dest: authServerId + src: id + operationId: revokeRefreshTokensForAuthorizationServerAndClient + - alias: listRefreshTokensForClient + arguments: + - dest: authServerId + src: id + operationId: listRefreshTokensForAuthorizationServerAndClient + - alias: getRefreshTokenForClient + arguments: + - dest: authServerId + src: id + operationId: getRefreshTokenForAuthorizationServerAndClient + - alias: revokeRefreshTokenForClient + arguments: + - dest: authServerId + src: id + operationId: revokeRefreshTokenForAuthorizationServerAndClient + - alias: listKeys + arguments: + - dest: authServerId + src: id + operationId: listAuthorizationServerKeys + - alias: rotateKeys + arguments: + - dest: authServerId + src: id + operationId: rotateAuthorizationServerKeys + - alias: activate + arguments: + - dest: authServerId + src: id + operationId: activateAuthorizationServer + - alias: deactivate + arguments: + - dest: authServerId + src: id + operationId: deactivateAuthorizationServer + - alias: listPolicies + arguments: + - dest: authServerId + src: id + operationId: listAuthorizationServerPolicies + - alias: createPolicy + arguments: + - dest: authServerId + src: id + operationId: createAuthorizationServerPolicy + - alias: deletePolicy + arguments: + - dest: authServerId + src: id + operationId: deleteAuthorizationServerPolicy + - alias: getPolicy + arguments: + - dest: authServerId + src: id + operationId: getAuthorizationServerPolicy + - alias: updatePolicy + arguments: + - dest: authServerId + src: id + operationId: updateAuthorizationServerPolicy + - alias: listOAuth2Scopes + arguments: + - dest: authServerId + src: id + operationId: listOAuth2Scopes + - alias: createOAuth2Scope + arguments: + - dest: authServerId + src: id + operationId: createOAuth2Scope + - alias: deleteOAuth2Scope + arguments: + - dest: authServerId + src: id + operationId: deleteOAuth2Scope + - alias: getOAuth2Scope + arguments: + - dest: authServerId + src: id + operationId: getOAuth2Scope + - alias: updateOAuth2Scope + arguments: + - dest: authServerId + src: id + operationId: updateOAuth2Scope + x-okta-tags: + - AuthorizationServer + AuthorizationServerCredentials: + properties: + signing: + $ref: '#/components/schemas/AuthorizationServerCredentialsSigningConfig' + type: object + x-okta-tags: + - Application + AuthorizationServerCredentialsRotationMode: + enum: + - AUTO + - MANUAL + type: string + x-okta-tags: + - AuthorizationServer + AuthorizationServerCredentialsSigningConfig: + properties: + kid: + type: string + lastRotated: + format: date-time + readOnly: true + type: string + nextRotation: + format: date-time + readOnly: true + type: string + rotationMode: + $ref: '#/components/schemas/AuthorizationServerCredentialsRotationMode' + use: + $ref: '#/components/schemas/AuthorizationServerCredentialsUse' + type: object + x-okta-tags: + - AuthorizationServer + AuthorizationServerCredentialsUse: + enum: + - sig + type: string + x-okta-tags: + - AuthorizationServer + AuthorizationServerPolicy: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + conditions: + $ref: '#/components/schemas/PolicyRuleConditions' + created: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + priority: + type: integer + status: + enum: + - ACTIVE + - INACTIVE + type: string + system: + type: boolean + type: + $ref: '#/components/schemas/PolicyType' + type: object + x-okta-crud: + - alias: read + arguments: + - dest: policyId + src: id + operationId: getAuthorizationServerPolicy + - alias: update + arguments: + - dest: policyId + src: id + - dest: policy + self: true + operationId: updateAuthorizationServerPolicy + - alias: delete + arguments: + - dest: policyId + src: id + operationId: deleteAuthorizationServerPolicy + x-okta-operations: + - alias: listPolicyRules + arguments: + - dest: policyId + src: id + operationId: listAuthorizationServerPolicyRules + - alias: createPolicyRule + arguments: + - dest: policyId + src: id + operationId: createAuthorizationServerPolicyRule + - alias: getPolicyRule + arguments: + - dest: policyId + src: id + operationId: getAuthorizationServerPolicyRule + - alias: deletePolicyRule + arguments: + - dest: policyId + src: id + operationId: deleteAuthorizationServerPolicyRule + - alias: activate + arguments: + - dest: policyId + src: id + operationId: activateAuthorizationServerPolicy + - alias: deactivate + arguments: + - dest: policyId + src: id + operationId: deactivateAuthorizationServerPolicy + x-okta-tags: + - AuthorizationServer + AuthorizationServerPolicyRule: + properties: + actions: + $ref: '#/components/schemas/AuthorizationServerPolicyRuleActions' + conditions: + $ref: '#/components/schemas/AuthorizationServerPolicyRuleConditions' + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + priority: + type: integer + status: + default: ACTIVE + enum: + - ACTIVE + - INACTIVE + type: string + system: + default: false + type: boolean + type: + enum: + - RESOURCE_ACCESS + type: string + type: object + x-okta-crud: + - alias: update + arguments: + - dest: ruleId + src: id + - dest: policyRule + self: true + - dest: policyId + parentSrc: id + operationId: updateAuthorizationServerPolicyRule + - alias: delete + arguments: + - dest: ruleId + src: id + - dest: policyId + parentSrc: policyId + operationId: deleteAuthorizationServerPolicyRule + x-okta-operations: + - alias: activate + arguments: + - dest: ruleId + src: id + - dest: policyId + parentSrc: policyId + operationId: activateAuthorizationServerPolicyRule + - alias: deactivate + arguments: + - dest: ruleId + src: id + - dest: policyId + parentSrc: policyId + operationId: deactivateAuthorizationServerPolicyRule + x-okta-tags: + - AuthorizationServerPolicy + AuthorizationServerPolicyRuleActions: + properties: + token: + $ref: '#/components/schemas/TokenAuthorizationServerPolicyRuleAction' + type: object + x-okta-tags: + - AuthorizationServerPolicy + AuthorizationServerPolicyRuleConditions: + properties: + clients: + $ref: '#/components/schemas/ClientPolicyCondition' + grantTypes: + $ref: '#/components/schemas/GrantTypePolicyRuleCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + scopes: + $ref: '#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition' + type: object + x-okta-tags: + - AuthorizationServerPolicy + BeforeScheduledActionPolicyRuleCondition: + properties: + duration: + $ref: '#/components/schemas/Duration' + lifecycleAction: + $ref: '#/components/schemas/ScheduledUserLifecycleAction' + type: object + x-okta-tags: + - Policy + ClientPolicyCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + ContextPolicyRuleCondition: + properties: + expression: + type: string + type: object + x-okta-tags: + - Policy + DevicePolicyRuleCondition: + properties: + migrated: + type: boolean + platform: + $ref: '#/components/schemas/DevicePolicyRuleConditionPlatform' + rooted: + type: boolean + trustLevel: + enum: + - ANY + - TRUSTED + type: string + type: object + x-okta-tags: + - Policy + DevicePolicyRuleConditionPlatform: + properties: + supportedMDMFrameworks: + items: + enum: + - AFW + - SAFE + - NATIVE + type: string + type: array + types: + items: + enum: + - IOS + - ANDROID + - OSX + - WINDOWS + type: string + type: array + type: object + x-okta-tags: + - Policy + Duration: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + GrantTypePolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + GroupCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + GroupPolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + IdentityProviderPolicyRuleCondition: + properties: + idpIds: + items: + type: string + type: array + provider: + enum: + - ANY + - OKTA + - SPECIFIC_IDP + type: string + type: object + x-okta-tags: + - Policy + InactivityPolicyRuleCondition: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + JsonWebKey: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + alg: + type: string + created: + format: date-time + type: string + e: + type: string + expiresAt: + format: date-time + type: string + key_ops: + items: + type: string + type: array + kid: + type: string + kty: + type: string + lastUpdated: + format: date-time + type: string + n: + type: string + status: + type: string + use: + type: string + x5c: + items: + type: string + type: array + x5t: + type: string + x5t#S256: + type: string + x5u: + type: string + type: object + x-okta-tags: + - Application + JwkUse: + properties: + use: + enum: + - sig + type: string + type: object + x-okta-tags: + - Application + LifecycleExpirationPolicyRuleCondition: + properties: + lifecycleStatus: + type: string + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + MDMEnrollmentPolicyRuleCondition: + properties: + blockNonSafeAndroid: + type: boolean + enrollment: + enum: + - OMM + - ANY_OR_NONE + type: string + type: object + x-okta-tags: + - Policy + OAuth2Actor: + properties: + id: + readOnly: true + type: string + type: + type: string + type: object + x-okta-tags: + - Application + OAuth2Claim: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + alwaysIncludeInToken: + type: boolean + claimType: + enum: + - IDENTITY + - RESOURCE + type: string + conditions: + $ref: '#/components/schemas/OAuth2ClaimConditions' + group_filter_type: + enum: + - STARTS_WITH + - EQUALS + - CONTAINS + - REGEX + type: string + id: + readOnly: true + type: string + name: + type: string + status: + enum: + - ACTIVE + - INACTIVE + type: string + system: + type: boolean + value: + type: string + valueType: + enum: + - EXPRESSION + - GROUPS + - SYSTEM + type: string + type: object + x-okta-tags: + - Application + OAuth2ClaimConditions: + properties: + scopes: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + OAuth2Client: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + client_id: + readOnly: true + type: string + client_name: + readOnly: true + type: string + client_uri: + readOnly: true + type: string + logo_uri: + readOnly: true + type: string + type: object + x-okta-tags: + - Application + OAuth2RefreshToken: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + clientId: + type: string + created: + format: date-time + readOnly: true + type: string + createdBy: + $ref: '#/components/schemas/OAuth2Actor' + expiresAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + issuer: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + scopes: + items: + type: string + type: array + status: + enum: + - ACTIVE + - REVOKED + type: string + userId: + type: string + type: object + x-okta-tags: + - Application + OAuth2Scope: + properties: + consent: + enum: + - REQUIRED + - IMPLICIT + - ADMIN + type: string + default: + type: boolean + description: + type: string + displayName: + type: string + id: + readOnly: true + type: string + metadataPublish: + enum: + - ALL_CLIENTS + - NO_CLIENTS + type: string + name: + type: string + system: + type: boolean + type: object + x-okta-tags: + - Application + OAuth2ScopesMediationPolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + PasswordExpirationPolicyRuleCondition: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyAuthenticationProviderCondition: + properties: + include: + items: + type: string + type: array + provider: + enum: + - ACTIVE_DIRECTORY + - ANY + - LDAP + - OKTA + type: string + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatform: + properties: + os: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystem' + type: + enum: + - DESKTOP + - MOBILE + - OTHER + - ANY + type: string + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatformOperatingSystem: + properties: + expression: + type: string + type: + enum: + - ANDROID + - IOS + - WINDOWS + - OSX + - OTHER + - ANY + type: string + version: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion' + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatformOperatingSystemVersion: + properties: + matchType: + enum: + - EXPRESSION + - SEMVER + type: string + value: + type: string + type: object + x-okta-tags: + - Policy + PlatformPolicyRuleCondition: + properties: + exclude: + items: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatform' + type: array + include: + items: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatform' + type: array + type: object + x-okta-tags: + - Policy + PolicyNetworkCondition: + properties: + connection: + enum: + - ANYWHERE + - ZONE + type: string + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PolicyPeopleCondition: + properties: + groups: + $ref: '#/components/schemas/GroupCondition' + users: + $ref: '#/components/schemas/UserCondition' + type: object + x-okta-tags: + - Policy + PolicyRuleAuthContextCondition: + properties: + authType: + enum: + - ANY + - RADIUS + type: string + type: object + x-okta-tags: + - Policy + PolicyRuleConditions: + properties: + app: + $ref: '#/components/schemas/AppAndInstancePolicyRuleCondition' + apps: + $ref: '#/components/schemas/AppInstancePolicyRuleCondition' + authContext: + $ref: '#/components/schemas/PolicyRuleAuthContextCondition' + authProvider: + $ref: '#/components/schemas/PasswordPolicyAuthenticationProviderCondition' + beforeScheduledAction: + $ref: '#/components/schemas/BeforeScheduledActionPolicyRuleCondition' + clients: + $ref: '#/components/schemas/ClientPolicyCondition' + context: + $ref: '#/components/schemas/ContextPolicyRuleCondition' + device: + $ref: '#/components/schemas/DevicePolicyRuleCondition' + grantTypes: + $ref: '#/components/schemas/GrantTypePolicyRuleCondition' + groups: + $ref: '#/components/schemas/GroupPolicyRuleCondition' + identityProvider: + $ref: '#/components/schemas/IdentityProviderPolicyRuleCondition' + mdmEnrollment: + $ref: '#/components/schemas/MDMEnrollmentPolicyRuleCondition' + network: + $ref: '#/components/schemas/PolicyNetworkCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + platform: + $ref: '#/components/schemas/PlatformPolicyRuleCondition' + risk: + $ref: '#/components/schemas/RiskPolicyRuleCondition' + riskScore: + $ref: '#/components/schemas/RiskScorePolicyRuleCondition' + scopes: + $ref: '#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition' + userIdentifier: + $ref: '#/components/schemas/UserIdentifierPolicyRuleCondition' + userStatus: + $ref: '#/components/schemas/UserStatusPolicyRuleCondition' + users: + $ref: '#/components/schemas/UserPolicyRuleCondition' + type: object + x-okta-tags: + - Policy + PolicyType: + enum: + - OAUTH_AUTHORIZATION_POLICY + - OKTA_SIGN_ON + - PASSWORD + - IDP_DISCOVERY + type: string + x-okta-tags: + - Policy + RiskPolicyRuleCondition: + properties: + behaviors: + items: + type: string + type: array + uniqueItems: true + type: object + x-okta-tags: + - Policy + RiskScorePolicyRuleCondition: + properties: + level: + type: string + type: object + x-okta-tags: + - Policy + ScheduledUserLifecycleAction: + properties: + status: + enum: + - ACTIVE + - INACTIVE + - PENDING + - DELETED + - EXPIRED_PASSWORD + - ACTIVATING + - SUSPENDED + - DELETING + type: string + type: object + x-okta-tags: + - Policy + TokenAuthorizationServerPolicyRuleAction: + properties: + accessTokenLifetimeMinutes: + type: integer + inlineHook: + $ref: '#/components/schemas/TokenAuthorizationServerPolicyRuleActionInlineHook' + refreshTokenLifetimeMinutes: + type: integer + refreshTokenWindowMinutes: + type: integer + type: object + x-okta-tags: + - AuthorizationServerPolicy + TokenAuthorizationServerPolicyRuleActionInlineHook: + properties: + id: + type: string + type: object + x-okta-tags: + - AuthorizationServerPolicy + UserCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + UserIdentifierConditionEvaluatorPattern: + properties: + matchType: + enum: + - SUFFIX + - EXPRESSION + - STARTS_WITH + - EQUALS + - CONTAINS + type: string + value: + type: string + type: object + x-okta-tags: + - Policy + UserIdentifierPolicyRuleCondition: + properties: + attribute: + type: string + patterns: + items: + $ref: '#/components/schemas/UserIdentifierConditionEvaluatorPattern' + type: array + type: + enum: + - IDENTIFIER + - ATTRIBUTE + type: string + type: object + x-okta-tags: + - Policy + UserLifecycleAttributePolicyRuleCondition: + properties: + attributeName: + type: string + matchingValue: + type: string + type: object + x-okta-tags: + - Policy + UserPolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + inactivity: + $ref: '#/components/schemas/InactivityPolicyRuleCondition' + include: + items: + type: string + type: array + lifecycleExpiration: + $ref: '#/components/schemas/LifecycleExpirationPolicyRuleCondition' + passwordExpiration: + $ref: '#/components/schemas/PasswordExpirationPolicyRuleCondition' + userLifecycleAttribute: + $ref: '#/components/schemas/UserLifecycleAttributePolicyRuleCondition' + type: object + x-okta-tags: + - Policy + UserStatusPolicyRuleCondition: + properties: + value: + enum: + - ACTIVE + - INACTIVE + - PENDING + - DELETED + - EXPIRED_PASSWORD + - ACTIVATING + - SUSPENDED + - DELETING + type: string + type: object + x-okta-tags: + - Policy + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + authorizationservers: + id: okta.authorizationserver.authorizationservers + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/lifecycle/activate + response: + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate + response: + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/authorizationServers/{authServerId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/authorizationServers/{authServerId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: authorizationservers + title: authorizationservers + claims: + id: okta.authorizationserver.claims + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/authorizationServers/{authServerId}/claims/{claimId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/claims/{claimId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/claims + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/claims + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/authorizationServers/{authServerId}/claims/{claimId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: claims + title: claims + clients: + id: okta.authorizationserver.clients + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/clients + response: + mediaType: application/json + openAPIDocKey: '200' + name: clients + title: clients + keys: + id: okta.authorizationserver.keys + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/credentials/keys + response: + mediaType: application/json + openAPIDocKey: '200' + rotate: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: keys + title: keys + policies: + id: okta.authorizationserver.policies + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate + response: + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate + response: + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: policies + title: policies + rules: + id: okta.authorizationserver.rules + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate + response: + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate + response: + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: rules + title: rules + scopes: + id: okta.authorizationserver.scopes + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/authorizationServers/{authServerId}/scopes/{scopeId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/scopes/{scopeId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/authorizationServers/{authServerId}/scopes + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/scopes + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/authorizationServers/{authServerId}/scopes/{scopeId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: scopes + title: scopes + tokens: + id: okta.authorizationserver.tokens + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId} + response: + openAPIDocKey: '204' + deleteall: + operation: + $ref: DELETE + path: + $ref: /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens + response: + mediaType: application/json + openAPIDocKey: '200' + name: tokens + title: tokens +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/authorizationServers: + get: + description: Success + operationId: listAuthorizationServers + parameters: + - in: query + name: q + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: after + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AuthorizationServer' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + post: + description: Success + operationId: createAuthorizationServer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServer' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServer' + description: Success + '201': + content: {} + description: Created + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: authorizationServer + /api/v1/authorizationServers/{authServerId}: + delete: + description: Success + operationId: deleteAuthorizationServer + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - AuthorizationServer + get: + description: Success + operationId: getAuthorizationServer + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServer' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + put: + description: Success + operationId: updateAuthorizationServer + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServer' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServer' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: authorizationServer + /api/v1/authorizationServers/{authServerId}/claims: + get: + description: Success + operationId: listOAuth2Claims + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2Claim' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + post: + description: Success + operationId: createOAuth2Claim + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Claim' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Claim' + description: Created + '201': + content: {} + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: oAuth2Claim + /api/v1/authorizationServers/{authServerId}/claims/{claimId}: + delete: + description: Success + operationId: deleteOAuth2Claim + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: claimId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - AuthorizationServer + get: + description: Success + operationId: getOAuth2Claim + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: claimId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Claim' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + put: + description: Success + operationId: updateOAuth2Claim + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: claimId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Claim' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Claim' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: oAuth2Claim + /api/v1/authorizationServers/{authServerId}/clients: + get: + description: Success + operationId: listOAuth2ClientsForAuthorizationServer + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2Client' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens: + delete: + description: Success + operationId: revokeRefreshTokensForAuthorizationServerAndClient + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - AuthorizationServer + get: + description: Success + operationId: listRefreshTokensForAuthorizationServerAndClient + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2RefreshToken' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}: + delete: + description: Success + operationId: revokeRefreshTokenForAuthorizationServerAndClient + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + - in: path + name: tokenId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - AuthorizationServer + get: + description: Success + operationId: getRefreshTokenForAuthorizationServerAndClient + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + - in: path + name: tokenId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2RefreshToken' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/credentials/keys: + get: + description: Success + operationId: listAuthorizationServerKeys + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/JsonWebKey' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate: + post: + description: Success + operationId: rotateAuthorizationServerKeys + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/JwkUse' + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/JsonWebKey' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: use + /api/v1/authorizationServers/{authServerId}/lifecycle/activate: + post: + description: Success + operationId: activateAuthorizationServer + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate: + post: + description: Success + operationId: deactivateAuthorizationServer + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/policies: + get: + description: Success + operationId: listAuthorizationServerPolicies + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AuthorizationServerPolicy' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + post: + description: Success + operationId: createAuthorizationServerPolicy + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicy' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicy' + description: Success + '201': + content: {} + description: Created + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: policy + /api/v1/authorizationServers/{authServerId}/policies/{policyId}: + delete: + description: Success + operationId: deleteAuthorizationServerPolicy + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: policyId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - AuthorizationServer + get: + description: Success + operationId: getAuthorizationServerPolicy + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: policyId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicy' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + put: + description: Success + operationId: updateAuthorizationServerPolicy + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: policyId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicy' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicy' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: policy + /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate: + post: + description: Activate Authorization Server Policy + operationId: activateAuthorizationServerPolicy + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: policyId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate: + post: + description: Deactivate Authorization Server Policy + operationId: deactivateAuthorizationServerPolicy + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: policyId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules: + get: + description: Enumerates all policy rules for the specified Custom Authorization + Server and Policy. + operationId: listAuthorizationServerPolicyRules + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: authServerId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AuthorizationServerPolicyRule' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + post: + description: Creates a policy rule for the specified Custom Authorization Server + and Policy. + operationId: createAuthorizationServerPolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: authServerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicyRule' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicyRule' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: policyRule + /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}: + delete: + description: Deletes a Policy Rule defined in the specified Custom Authorization + Server and Policy. + operationId: deleteAuthorizationServerPolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - AuthorizationServer + get: + description: Returns a Policy Rule by ID that is defined in the specified Custom + Authorization Server and Policy. + operationId: getAuthorizationServerPolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicyRule' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + put: + description: Updates the configuration of the Policy Rule defined in the specified + Custom Authorization Server and Policy. + operationId: updateAuthorizationServerPolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicyRule' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationServerPolicyRule' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: policyRule + /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate: + post: + description: Activate Authorization Server Policy Rule + operationId: activateAuthorizationServerPolicyRule + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate: + post: + description: Deactivate Authorization Server Policy Rule + operationId: deactivateAuthorizationServerPolicyRule + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + /api/v1/authorizationServers/{authServerId}/scopes: + get: + description: Success + operationId: listOAuth2Scopes + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: cursor + schema: + type: string + - in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2Scope' + type: array + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + post: + description: Success + operationId: createOAuth2Scope + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Scope' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Scope' + description: Success + '201': + content: {} + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: oAuth2Scope + /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}: + delete: + description: Success + operationId: deleteOAuth2Scope + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: scopeId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - AuthorizationServer + get: + description: Success + operationId: getOAuth2Scope + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: scopeId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Scope' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + put: + description: Success + operationId: updateOAuth2Scope + parameters: + - in: path + name: authServerId + required: true + schema: + type: string + - in: path + name: scopeId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Scope' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2Scope' + description: Success + security: + - api_token: [] + tags: + - AuthorizationServer + x-codegen-request-body-name: oAuth2Scope +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/AuthorizationServer.yaml.sig b/test/registry/src/okta/v1/services/AuthorizationServer.yaml.sig new file mode 100644 index 00000000..57a9a336 --- /dev/null +++ b/test/registry/src/okta/v1/services/AuthorizationServer.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnJNp+eAKU9WrTBYTrQQvd+ZhpVFmgY9GE5ZPkwfEeO5DBHiAbHVqbdhvCYFl+fn8PNtuivIYeUBlwzJmtGkM//lOpXpAMDQ== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Domain.yaml b/test/registry/src/okta/v1/services/Domain.yaml new file mode 100644 index 00000000..3b181e15 --- /dev/null +++ b/test/registry/src/okta/v1/services/Domain.yaml @@ -0,0 +1,319 @@ +components: + schemas: + DNSRecord: + properties: + expiration: + type: string + fqdn: + type: string + recordType: + $ref: '#/components/schemas/DNSRecordType' + values: + items: + type: string + type: array + type: object + x-okta-tags: + - Domain + DNSRecordType: + enum: + - TXT + - CNAME + type: string + x-okta-tags: + - Domain + Domain: + properties: + certificateSourceType: + $ref: '#/components/schemas/DomainCertificateSourceType' + dnsRecords: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + domain: + type: string + id: + readOnly: true + type: string + publicCertificate: + $ref: '#/components/schemas/DomainCertificateMetadata' + validationStatus: + $ref: '#/components/schemas/DomainValidationStatus' + type: object + x-okta-tags: + - Domain + DomainCertificate: + properties: + certificate: + type: string + certificateChain: + type: string + privateKey: + type: string + type: + $ref: '#/components/schemas/DomainCertificateType' + type: object + x-okta-operations: + - alias: createCertificate + arguments: + - dest: certificate + self: true + operationId: createCertificate + x-okta-tags: + - Domain + DomainCertificateMetadata: + properties: + expiration: + type: string + fingerprint: + type: string + subject: + type: string + type: object + x-okta-tags: + - Domain + DomainCertificateSourceType: + enum: + - MANUAL + type: string + x-okta-tags: + - Domain + DomainCertificateType: + enum: + - PEM + type: string + x-okta-tags: + - Domain + DomainListResponse: + properties: + domains: + items: + $ref: '#/components/schemas/Domain' + type: array + type: object + x-okta-tags: + - Domain + DomainValidationStatus: + enum: + - NOT_STARTED + - IN_PROGRESS + - VERIFIED + - COMPLETED + type: string + x-okta-tags: + - Domain + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + certificates: + id: okta.domain.certificates + methods: + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/domains/{domainId}/certificate + request: + mediaType: application/json + response: + openAPIDocKey: '204' + name: certificates + title: certificates + domains: + id: okta.domain.domains + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/domains/{domainId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/domains/{domainId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/domains + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/domains + response: + mediaType: application/json + openAPIDocKey: '200' + verify: + operation: + $ref: POST + path: + $ref: /api/v1/domains/{domainId}/verify + response: + mediaType: application/json + openAPIDocKey: '200' + name: domains + title: domains +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/domains: + get: + description: List all verified custom Domains for the org. + operationId: listDomains + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DomainListResponse' + description: Success + security: + - api_token: [] + summary: List Domains + tags: + - Domain + post: + description: Creates your domain. + operationId: createDomain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Domain' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Domain' + description: Success + security: + - api_token: [] + summary: Create Domain + tags: + - Domain + x-codegen-request-body-name: domain + /api/v1/domains/{domainId}: + delete: + description: Deletes a Domain by `id`. + operationId: deleteDomain + parameters: + - in: path + name: domainId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Delete Domain + tags: + - Domain + get: + description: Fetches a Domain by `id`. + operationId: getDomain + parameters: + - in: path + name: domainId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Domain' + description: Success + security: + - api_token: [] + summary: Get Domain + tags: + - Domain + /api/v1/domains/{domainId}/certificate: + put: + description: Creates the Certificate for the Domain. + operationId: createCertificate + parameters: + - in: path + name: domainId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainCertificate' + required: true + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Create Certificate + tags: + - Domain + x-codegen-request-body-name: certificate + /api/v1/domains/{domainId}/verify: + post: + description: Verifies the Domain by `id`. + operationId: verifyDomain + parameters: + - in: path + name: domainId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Domain' + description: Success + security: + - api_token: [] + summary: Verify Domain + tags: + - Domain +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Domain.yaml.sig b/test/registry/src/okta/v1/services/Domain.yaml.sig new file mode 100644 index 00000000..41193090 --- /dev/null +++ b/test/registry/src/okta/v1/services/Domain.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnAp21UAKU59psFAvX35sD85e2lywMEJG9bPp6qTg8ROUwGmJxd/4zynDQuOYTjjnmMsSbTyAGdZR62ddEpgzMKXhs+wfoAw== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/EventHook.yaml b/test/registry/src/okta/v1/services/EventHook.yaml new file mode 100644 index 00000000..7e8bbd54 --- /dev/null +++ b/test/registry/src/okta/v1/services/EventHook.yaml @@ -0,0 +1,414 @@ +components: + schemas: + EventHook: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + channel: + $ref: '#/components/schemas/EventHookChannel' + created: + format: date-time + readOnly: true + type: string + createdBy: + type: string + events: + $ref: '#/components/schemas/EventSubscriptions' + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + status: + enum: + - ACTIVE + - INACTIVE + type: string + verificationStatus: + enum: + - UNVERIFIED + - VERIFIED + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: eventHook + self: true + operationId: createEventHook + - alias: read + arguments: [] + operationId: getEventHook + - alias: update + arguments: + - dest: eventHookId + src: id + - dest: eventHook + self: true + operationId: updateEventHook + - alias: delete + arguments: + - dest: eventHookId + src: id + operationId: deleteEventHook + x-okta-operations: + - alias: activate + arguments: + - dest: eventHookId + src: id + operationId: activateEventHook + - alias: deactivate + arguments: + - dest: eventHookId + src: id + operationId: deactivateEventHook + - alias: verify + arguments: + - dest: eventHookId + src: id + operationId: verifyEventHook + x-okta-tags: + - EventHook + EventHookChannel: + properties: + config: + $ref: '#/components/schemas/EventHookChannelConfig' + type: + enum: + - HTTP + type: string + version: + type: string + type: object + x-okta-tags: + - EventHook + EventHookChannelConfig: + properties: + authScheme: + $ref: '#/components/schemas/EventHookChannelConfigAuthScheme' + headers: + items: + $ref: '#/components/schemas/EventHookChannelConfigHeader' + type: array + uri: + type: string + type: object + x-okta-tags: + - EventHook + EventHookChannelConfigAuthScheme: + properties: + key: + type: string + type: + $ref: '#/components/schemas/EventHookChannelConfigAuthSchemeType' + value: + type: string + type: object + x-okta-tags: + - EventHook + EventHookChannelConfigAuthSchemeType: + enum: + - HEADER + type: string + x-okta-tags: + - EventHook + EventHookChannelConfigHeader: + properties: + key: + type: string + value: + type: string + type: object + x-okta-tags: + - EventHook + EventSubscriptions: + discriminator: + propertyName: type + properties: + items: + items: + type: string + type: array + type: + enum: + - EVENT_TYPE + - FLOW_EVENT + type: string + type: object + x-okta-tags: + - EventHook + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + eventhooks: + id: okta.eventhook.eventhooks + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/eventHooks/{eventHookId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/eventHooks/{eventHookId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/eventHooks/{eventHookId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/eventHooks/{eventHookId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/eventHooks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/eventHooks + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/eventHooks/{eventHookId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + verify: + operation: + $ref: POST + path: + $ref: /api/v1/eventHooks/{eventHookId}/lifecycle/verify + response: + mediaType: application/json + openAPIDocKey: '200' + name: eventhooks + title: eventhooks +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/eventHooks: + get: + description: Success + operationId: listEventHooks + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/EventHook' + type: array + description: Success + security: + - api_token: [] + tags: + - EventHook + post: + description: Success + operationId: createEventHook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EventHook' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventHook' + description: Success + security: + - api_token: [] + tags: + - EventHook + x-codegen-request-body-name: eventHook + /api/v1/eventHooks/{eventHookId}: + delete: + description: Success + operationId: deleteEventHook + parameters: + - in: path + name: eventHookId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - EventHook + get: + description: Success + operationId: getEventHook + parameters: + - in: path + name: eventHookId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventHook' + description: Success + security: + - api_token: [] + tags: + - EventHook + put: + description: Success + operationId: updateEventHook + parameters: + - in: path + name: eventHookId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EventHook' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventHook' + description: Success + security: + - api_token: [] + tags: + - EventHook + x-codegen-request-body-name: eventHook + /api/v1/eventHooks/{eventHookId}/lifecycle/activate: + post: + description: Success + operationId: activateEventHook + parameters: + - in: path + name: eventHookId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventHook' + description: Success + security: + - api_token: [] + tags: + - EventHook + /api/v1/eventHooks/{eventHookId}/lifecycle/deactivate: + post: + description: Success + operationId: deactivateEventHook + parameters: + - in: path + name: eventHookId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventHook' + description: Success + security: + - api_token: [] + tags: + - EventHook + /api/v1/eventHooks/{eventHookId}/lifecycle/verify: + post: + description: Success + operationId: verifyEventHook + parameters: + - in: path + name: eventHookId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventHook' + description: Success + security: + - api_token: [] + tags: + - EventHook +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/EventHook.yaml.sig b/test/registry/src/okta/v1/services/EventHook.yaml.sig new file mode 100644 index 00000000..eeadb531 --- /dev/null +++ b/test/registry/src/okta/v1/services/EventHook.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnNFiqUAKU/UFyq9DAhbiLs3U1QeIWPMzZLmcnVVwOv/YYJQ+t6pqPKZb9ZWhgzG0ZUCztJG89d5aoBU96fzOuPRrrfJJRCQ== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Feature.yaml b/test/registry/src/okta/v1/services/Feature.yaml new file mode 100644 index 00000000..f47d9610 --- /dev/null +++ b/test/registry/src/okta/v1/services/Feature.yaml @@ -0,0 +1,270 @@ +components: + schemas: + EnabledStatus: + enum: + - ENABLED + - DISABLED + type: string + x-okta-tags: + - Common + Feature: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + description: + type: string + id: + readOnly: true + type: string + name: + type: string + stage: + $ref: '#/components/schemas/FeatureStage' + status: + $ref: '#/components/schemas/EnabledStatus' + type: + $ref: '#/components/schemas/FeatureType' + type: object + x-okta-crud: + - alias: read + arguments: [] + operationId: getFeature + x-okta-operations: + - alias: updateLifecycle + arguments: + - dest: featureId + src: id + operationId: updateFeatureLifecycle + - alias: getDependents + arguments: + - dest: featureId + src: id + operationId: listFeatureDependents + - alias: getDependencies + arguments: + - dest: featureId + src: id + operationId: listFeatureDependencies + x-okta-tags: + - Feature + FeatureStage: + properties: + state: + $ref: '#/components/schemas/FeatureStageState' + value: + $ref: '#/components/schemas/FeatureStageValue' + type: object + x-okta-tags: + - Feature + FeatureStageState: + enum: + - OPEN + - CLOSED + type: string + x-okta-tags: + - Feature + FeatureStageValue: + enum: + - EA + - BETA + type: string + x-okta-tags: + - Feature + FeatureType: + enum: + - self-service + type: string + x-okta-tags: + - Feature + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + features: + id: okta.feature.features + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/features/{featureId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/features + response: + mediaType: application/json + openAPIDocKey: '200' + listFeatureDependencies: + operation: + $ref: GET + path: + $ref: /api/v1/features/{featureId}/dependencies + response: + mediaType: application/json + openAPIDocKey: '200' + listFeatureDependents: + operation: + $ref: GET + path: + $ref: /api/v1/features/{featureId}/dependents + response: + mediaType: application/json + openAPIDocKey: '200' + updateFeatureLifecycle: + operation: + $ref: POST + path: + $ref: /api/v1/features/{featureId}/{lifecycle} + response: + mediaType: application/json + openAPIDocKey: '200' + name: features + title: features +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/features: + get: + description: Success + operationId: listFeatures + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Feature' + type: array + description: Success + security: + - api_token: [] + tags: + - Feature + /api/v1/features/{featureId}: + get: + description: Success + operationId: getFeature + parameters: + - in: path + name: featureId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Feature' + description: Success + security: + - api_token: [] + tags: + - Feature + /api/v1/features/{featureId}/dependencies: + get: + description: Success + operationId: listFeatureDependencies + parameters: + - in: path + name: featureId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Feature' + type: array + description: Success + security: + - api_token: [] + tags: + - Feature + /api/v1/features/{featureId}/dependents: + get: + description: Success + operationId: listFeatureDependents + parameters: + - in: path + name: featureId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Feature' + type: array + description: Success + security: + - api_token: [] + tags: + - Feature + /api/v1/features/{featureId}/{lifecycle}: + post: + description: Success + operationId: updateFeatureLifecycle + parameters: + - in: path + name: featureId + required: true + schema: + type: string + - in: path + name: lifecycle + required: true + schema: + type: string + - in: query + name: mode + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Feature' + description: Success + security: + - api_token: [] + tags: + - Feature +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Feature.yaml.sig b/test/registry/src/okta/v1/services/Feature.yaml.sig new file mode 100644 index 00000000..d954ac6d --- /dev/null +++ b/test/registry/src/okta/v1/services/Feature.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmMpxImAKU4hFfPLLPRbedpZDsoQ3IMk7m7Ts+k1ue9l9eWbXxgxvf/I9cb5+cVaS2Y66INMwwtmUABFLsabOowsdFL47MCA== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Group.yaml b/test/registry/src/okta/v1/services/Group.yaml new file mode 100644 index 00000000..d5f20f2a --- /dev/null +++ b/test/registry/src/okta/v1/services/Group.yaml @@ -0,0 +1,3075 @@ +components: + schemas: + AcsEndpoint: + properties: + index: + type: integer + url: + type: string + type: object + x-okta-tags: + - Application + Application: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + accessibility: + $ref: '#/components/schemas/ApplicationAccessibility' + created: + format: date-time + readOnly: true + type: string + credentials: + $ref: '#/components/schemas/ApplicationCredentials' + features: + items: + type: string + type: array + id: + readOnly: true + type: string + label: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + licensing: + $ref: '#/components/schemas/ApplicationLicensing' + name: + readOnly: true + type: string + profile: + additionalProperties: + properties: {} + type: object + type: object + settings: + $ref: '#/components/schemas/ApplicationSettings' + signOnMode: + $ref: '#/components/schemas/ApplicationSignOnMode' + status: + enum: + - ACTIVE + - INACTIVE + - DELETED + readOnly: true + type: string + visibility: + $ref: '#/components/schemas/ApplicationVisibility' + type: object + x-okta-crud: + - alias: read + arguments: + - dest: appId + src: id + operationId: getApplication + - alias: update + arguments: + - dest: appId + src: id + - dest: application + self: true + operationId: updateApplication + - alias: delete + arguments: + - dest: appId + src: id + operationId: deleteApplication + x-okta-operations: + - alias: activate + arguments: + - dest: appId + src: id + operationId: activateApplication + - alias: deactivate + arguments: + - dest: appId + src: id + operationId: deactivateApplication + - alias: listApplicationUsers + arguments: + - dest: appId + src: id + operationId: listApplicationUsers + - alias: assignUserToApplication + arguments: + - dest: appId + src: id + operationId: assignUserToApplication + - alias: getApplicationUser + arguments: + - dest: appId + src: id + operationId: getApplicationUser + - alias: createApplicationGroupAssignment + arguments: + - dest: appId + src: id + operationId: createApplicationGroupAssignment + - alias: getApplicationGroupAssignment + arguments: + - dest: appId + src: id + operationId: getApplicationGroupAssignment + - alias: cloneApplicationKey + arguments: + - dest: appId + src: id + operationId: cloneApplicationKey + - alias: getApplicationKey + arguments: + - dest: appId + src: id + operationId: getApplicationKey + - alias: listGroupAssignments + arguments: + - dest: appId + src: id + operationId: listApplicationGroupAssignments + - alias: listKeys + arguments: + - dest: appId + src: id + operationId: listApplicationKeys + - alias: generateKey + arguments: + - dest: appId + src: id + operationId: generateApplicationKey + - alias: generateCsr + arguments: + - dest: appId + src: id + operationId: generateCsrForApplication + - alias: getCsr + arguments: + - dest: appId + src: id + operationId: getCsrForApplication + - alias: revokeCsr + arguments: + - dest: appId + src: id + operationId: revokeCsrFromApplication + - alias: listCsrs + arguments: + - dest: appId + src: id + operationId: listCsrsForApplication + - alias: publishCerCert + arguments: + - dest: appId + src: id + operationId: publishCerCert + - alias: publishBinaryCerCert + arguments: + - dest: appId + src: id + operationId: publishBinaryCerCert + - alias: publishDerCert + arguments: + - dest: appId + src: id + operationId: publishDerCert + - alias: publishBinaryDerCert + arguments: + - dest: appId + src: id + operationId: publishBinaryDerCert + - alias: publishBinaryPemCert + arguments: + - dest: appId + src: id + operationId: publishBinaryPemCert + - alias: listOAuth2Tokens + arguments: + - dest: appId + src: id + operationId: listOAuth2TokensForApplication + - alias: revokeOAuth2TokenForApplication + arguments: + - dest: appId + src: id + operationId: revokeOAuth2TokenForApplication + - alias: getOAuth2Token + arguments: + - dest: appId + src: id + operationId: getOAuth2TokenForApplication + - alias: revokeOAuth2Tokens + arguments: + - dest: appId + src: id + operationId: revokeOAuth2TokensForApplication + - alias: listScopeConsentGrants + arguments: + - dest: appId + src: id + operationId: listScopeConsentGrants + - alias: grantConsentToScope + arguments: + - dest: appId + src: id + operationId: grantConsentToScope + - alias: revokeScopeConsentGrant + arguments: + - dest: appId + src: id + operationId: revokeScopeConsentGrant + - alias: getScopeConsentGrant + arguments: + - dest: appId + src: id + operationId: getScopeConsentGrant + x-okta-tags: + - Application + x-openapi-v3-discriminator: + mapping: + AUTO_LOGIN: '#/components/schemas/AutoLoginApplication' + BASIC_AUTH: '#/components/schemas/BasicAuthApplication' + BOOKMARK: '#/components/schemas/BookmarkApplication' + BROWSER_PLUGIN: '#/components/schemas/BrowserPluginApplication' + OPENID_CONNECT: '#/components/schemas/OpenIdConnectApplication' + SAML_1_1: '#/components/schemas/SamlApplication' + SAML_2_0: '#/components/schemas/SamlApplication' + SECURE_PASSWORD_STORE: '#/components/schemas/SecurePasswordStoreApplication' + WS_FEDERATION: '#/components/schemas/WsFederationApplication' + propertyName: signOnMode + ApplicationAccessibility: + properties: + errorRedirectUrl: + type: string + loginRedirectUrl: + type: string + selfService: + type: boolean + type: object + x-okta-tags: + - Application + ApplicationCredentials: + properties: + signing: + $ref: '#/components/schemas/ApplicationCredentialsSigning' + userNameTemplate: + $ref: '#/components/schemas/ApplicationCredentialsUsernameTemplate' + type: object + x-okta-tags: + - Application + ApplicationCredentialsOAuthClient: + properties: + autoKeyRotation: + type: boolean + client_id: + type: string + client_secret: + type: string + token_endpoint_auth_method: + $ref: '#/components/schemas/OAuthEndpointAuthenticationMethod' + type: object + x-okta-tags: + - Application + ApplicationCredentialsScheme: + enum: + - SHARED_USERNAME_AND_PASSWORD + - EXTERNAL_PASSWORD_SYNC + - EDIT_USERNAME_AND_PASSWORD + - EDIT_PASSWORD_ONLY + - ADMIN_SETS_CREDENTIALS + type: string + x-okta-tags: + - Application + ApplicationCredentialsSigning: + properties: + kid: + type: string + lastRotated: + format: date-time + readOnly: true + type: string + nextRotation: + format: date-time + readOnly: true + type: string + rotationMode: + type: string + use: + $ref: '#/components/schemas/ApplicationCredentialsSigningUse' + type: object + x-okta-tags: + - Application + ApplicationCredentialsSigningUse: + enum: + - sig + type: string + x-okta-tags: + - AuthorizationServer + ApplicationCredentialsUsernameTemplate: + properties: + suffix: + type: string + template: + type: string + type: + type: string + type: object + x-okta-tags: + - Application + ApplicationLicensing: + properties: + seatCount: + type: integer + type: object + x-okta-tags: + - Application + ApplicationSettings: + properties: + app: + $ref: '#/components/schemas/ApplicationSettingsApplication' + implicitAssignment: + type: boolean + inlineHookId: + type: string + notes: + $ref: '#/components/schemas/ApplicationSettingsNotes' + notifications: + $ref: '#/components/schemas/ApplicationSettingsNotifications' + type: object + x-okta-tags: + - Application + ApplicationSettingsApplication: + type: object + x-okta-tags: + - Application + ApplicationSettingsNotes: + properties: + admin: + type: string + enduser: + type: string + type: object + x-okta-tags: + - Application + ApplicationSettingsNotifications: + properties: + vpn: + $ref: '#/components/schemas/ApplicationSettingsNotificationsVpn' + type: object + x-okta-tags: + - Application + ApplicationSettingsNotificationsVpn: + properties: + helpUrl: + type: string + message: + type: string + network: + $ref: '#/components/schemas/ApplicationSettingsNotificationsVpnNetwork' + type: object + x-okta-tags: + - Application + ApplicationSettingsNotificationsVpnNetwork: + properties: + connection: + type: string + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + ApplicationSignOnMode: + enum: + - BOOKMARK + - BASIC_AUTH + - BROWSER_PLUGIN + - SECURE_PASSWORD_STORE + - AUTO_LOGIN + - WS_FEDERATION + - SAML_2_0 + - OPENID_CONNECT + - SAML_1_1 + type: string + x-okta-tags: + - Application + ApplicationVisibility: + properties: + appLinks: + additionalProperties: + type: boolean + type: object + autoLaunch: + type: boolean + autoSubmitToolbar: + type: boolean + hide: + $ref: '#/components/schemas/ApplicationVisibilityHide' + type: object + x-okta-tags: + - Application + ApplicationVisibilityHide: + properties: + iOS: + type: boolean + web: + type: boolean + type: object + x-okta-tags: + - Application + AssignRoleRequest: + properties: + type: + $ref: '#/components/schemas/RoleType' + type: object + x-okta-tags: + - Role + AuthenticationProvider: + properties: + name: + type: string + type: + $ref: '#/components/schemas/AuthenticationProviderType' + type: object + x-okta-tags: + - User + AuthenticationProviderType: + enum: + - ACTIVE_DIRECTORY + - FEDERATION + - LDAP + - OKTA + - SOCIAL + - IMPORT + type: string + x-okta-tags: + - User + AutoLoginApplication: + properties: + credentials: + $ref: '#/components/schemas/SchemeApplicationCredentials' + settings: + $ref: '#/components/schemas/AutoLoginApplicationSettings' + type: object + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + AutoLoginApplicationSettings: + properties: + signOn: + $ref: '#/components/schemas/AutoLoginApplicationSettingsSignOn' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + AutoLoginApplicationSettingsSignOn: + properties: + loginUrl: + type: string + redirectUrl: + type: string + type: object + x-okta-tags: + - Application + BasicApplicationSettings: + properties: + app: + $ref: '#/components/schemas/BasicApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + BasicApplicationSettingsApplication: + properties: + authURL: + type: string + url: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + BasicAuthApplication: + properties: + credentials: + $ref: '#/components/schemas/SchemeApplicationCredentials' + name: + type: object + settings: + $ref: '#/components/schemas/BasicApplicationSettings' + type: object + x-okta-defined-as: + name: template_basic_auth + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + BookmarkApplication: + properties: + name: + type: object + settings: + $ref: '#/components/schemas/BookmarkApplicationSettings' + type: object + x-okta-defined-as: + name: bookmark + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + BookmarkApplicationSettings: + properties: + app: + $ref: '#/components/schemas/BookmarkApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + BookmarkApplicationSettingsApplication: + properties: + requestIntegration: + type: boolean + url: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + BrowserPluginApplication: + properties: + credentials: + $ref: '#/components/schemas/SchemeApplicationCredentials' + type: object + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + x-openapi-v3-discriminator: + mapping: + template_swa: '#/components/schemas/SwaApplication' + template_swa3field: '#/components/schemas/SwaThreeFieldApplication' + propertyName: name + CatalogApplication: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + category: + type: string + description: + type: string + displayName: + type: string + features: + items: + type: string + type: array + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + signOnModes: + items: + type: string + type: array + status: + $ref: '#/components/schemas/CatalogApplicationStatus' + verificationStatus: + type: string + website: + type: string + type: object + x-okta-tags: + - Role + CatalogApplicationStatus: + enum: + - ACTIVE + - INACTIVE + type: string + x-okta-tags: + - Role + Group: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + lastMembershipUpdated: + format: date-time + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + objectClass: + items: + type: string + readOnly: true + type: array + profile: + $ref: '#/components/schemas/GroupProfile' + type: + $ref: '#/components/schemas/GroupType' + type: object + x-okta-crud: + - alias: update + arguments: + - dest: groupId + src: id + - dest: group + self: true + operationId: updateGroup + - alias: delete + arguments: + - dest: groupId + src: id + operationId: deleteGroup + x-okta-operations: + - alias: removeUser + arguments: + - dest: groupId + src: id + operationId: removeUserFromGroup + - alias: listUsers + arguments: + - dest: groupId + src: id + operationId: listGroupUsers + - alias: listApplications + arguments: + - dest: groupId + src: id + operationId: listAssignedApplicationsForGroup + - alias: assignRole + arguments: + - dest: groupId + src: id + operationId: assignRoleToGroup + x-okta-tags: + - Group + GroupProfile: + properties: + description: + type: string + name: + type: string + type: object + x-okta-extensible: true + x-okta-tags: + - Group + GroupRule: + properties: + actions: + $ref: '#/components/schemas/GroupRuleAction' + conditions: + $ref: '#/components/schemas/GroupRuleConditions' + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + status: + $ref: '#/components/schemas/GroupRuleStatus' + type: + type: string + type: object + x-okta-crud: + - alias: update + arguments: + - dest: ruleId + src: id + - dest: groupRule + self: true + operationId: updateGroupRule + - alias: delete + arguments: + - dest: ruleId + src: id + operationId: deleteGroupRule + x-okta-operations: + - alias: activate + arguments: + - dest: ruleId + src: id + operationId: activateGroupRule + - alias: deactivate + arguments: + - dest: ruleId + src: id + operationId: deactivateGroupRule + x-okta-tags: + - GroupRule + GroupRuleAction: + properties: + assignUserToGroups: + $ref: '#/components/schemas/GroupRuleGroupAssignment' + type: object + x-okta-tags: + - GroupRule + GroupRuleConditions: + properties: + expression: + $ref: '#/components/schemas/GroupRuleExpression' + people: + $ref: '#/components/schemas/GroupRulePeopleCondition' + type: object + x-okta-tags: + - GroupRule + GroupRuleExpression: + properties: + type: + type: string + value: + type: string + type: object + x-okta-tags: + - GroupRule + GroupRuleGroupAssignment: + properties: + groupIds: + items: + type: string + type: array + type: object + x-okta-tags: + - GroupRule + GroupRuleGroupCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - GroupRule + GroupRulePeopleCondition: + properties: + groups: + $ref: '#/components/schemas/GroupRuleGroupCondition' + users: + $ref: '#/components/schemas/GroupRuleUserCondition' + type: object + x-okta-tags: + - GroupRule + GroupRuleStatus: + enum: + - ACTIVE + - INACTIVE + - INVALID + type: string + x-okta-tags: + - GroupRule + GroupRuleUserCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - GroupRule + GroupType: + enum: + - OKTA_GROUP + - APP_GROUP + - BUILT_IN + type: string + x-okta-tags: + - Group + JsonWebKey: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + alg: + type: string + created: + format: date-time + type: string + e: + type: string + expiresAt: + format: date-time + type: string + key_ops: + items: + type: string + type: array + kid: + type: string + kty: + type: string + lastUpdated: + format: date-time + type: string + n: + type: string + status: + type: string + use: + type: string + x5c: + items: + type: string + type: array + x5t: + type: string + x5t#S256: + type: string + x5u: + type: string + type: object + x-okta-tags: + - Application + OAuthApplicationCredentials: + properties: + oauthClient: + $ref: '#/components/schemas/ApplicationCredentialsOAuthClient' + type: object + x-okta-parent: '#/components/schemas/ApplicationCredentials' + x-okta-tags: + - Application + OAuthEndpointAuthenticationMethod: + enum: + - none + - client_secret_post + - client_secret_basic + - client_secret_jwt + - private_key_jwt + type: string + x-okta-tags: + - Application + OAuthGrantType: + enum: + - authorization_code + - implicit + - password + - refresh_token + - client_credentials + type: string + x-okta-tags: + - Application + OAuthResponseType: + enum: + - code + - token + - id_token + type: string + x-okta-tags: + - Application + OpenIdConnectApplication: + properties: + credentials: + $ref: '#/components/schemas/OAuthApplicationCredentials' + name: + type: object + settings: + $ref: '#/components/schemas/OpenIdConnectApplicationSettings' + type: object + x-okta-defined-as: + name: oidc_client + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + OpenIdConnectApplicationConsentMethod: + enum: + - REQUIRED + - TRUSTED + type: string + x-okta-tags: + - Application + OpenIdConnectApplicationIdpInitiatedLogin: + properties: + default_scope: + items: + type: string + type: array + mode: + type: string + type: object + x-okta-tags: + - Application + OpenIdConnectApplicationIssuerMode: + enum: + - CUSTOM_URL + - ORG_URL + type: string + x-okta-tags: + - Application + OpenIdConnectApplicationSettings: + properties: + oauthClient: + $ref: '#/components/schemas/OpenIdConnectApplicationSettingsClient' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + OpenIdConnectApplicationSettingsClient: + properties: + application_type: + $ref: '#/components/schemas/OpenIdConnectApplicationType' + client_uri: + type: string + consent_method: + $ref: '#/components/schemas/OpenIdConnectApplicationConsentMethod' + grant_types: + items: + $ref: '#/components/schemas/OAuthGrantType' + type: array + idp_initiated_login: + $ref: '#/components/schemas/OpenIdConnectApplicationIdpInitiatedLogin' + initiate_login_uri: + type: string + issuer_mode: + $ref: '#/components/schemas/OpenIdConnectApplicationIssuerMode' + jwks: + $ref: '#/components/schemas/OpenIdConnectApplicationSettingsClientKeys' + logo_uri: + type: string + policy_uri: + type: string + post_logout_redirect_uris: + items: + type: string + type: array + redirect_uris: + items: + type: string + type: array + refresh_token: + $ref: '#/components/schemas/OpenIdConnectApplicationSettingsRefreshToken' + response_types: + items: + $ref: '#/components/schemas/OAuthResponseType' + type: array + tos_uri: + type: string + wildcard_redirect: + type: string + type: object + x-okta-tags: + - Application + OpenIdConnectApplicationSettingsClientKeys: + properties: + keys: + items: + $ref: '#/components/schemas/JsonWebKey' + type: array + type: object + x-okta-tags: + - Application + OpenIdConnectApplicationSettingsRefreshToken: + properties: + leeway: + type: integer + rotation_type: + $ref: '#/components/schemas/OpenIdConnectRefreshTokenRotationType' + type: object + x-okta-tags: + - Application + OpenIdConnectApplicationType: + enum: + - web + - native + - browser + - service + type: string + x-okta-tags: + - Application + OpenIdConnectRefreshTokenRotationType: + enum: + - rotate + - static + type: string + x-okta-tags: + - Application + PasswordCredential: + properties: + hash: + $ref: '#/components/schemas/PasswordCredentialHash' + hook: + $ref: '#/components/schemas/PasswordCredentialHook' + value: + format: password + type: string + type: object + x-okta-tags: + - User + PasswordCredentialHash: + properties: + algorithm: + $ref: '#/components/schemas/PasswordCredentialHashAlgorithm' + salt: + type: string + saltOrder: + type: string + value: + type: string + workFactor: + type: integer + type: object + x-okta-tags: + - User + PasswordCredentialHashAlgorithm: + enum: + - BCRYPT + - SHA-512 + - SHA-256 + - SHA-1 + - MD5 + type: string + x-okta-tags: + - User + PasswordCredentialHook: + properties: + type: + type: string + type: object + x-okta-tags: + - User + RecoveryQuestionCredential: + properties: + answer: + type: string + question: + type: string + type: object + x-okta-tags: + - User + Role: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + assignmentType: + $ref: '#/components/schemas/RoleAssignmentType' + created: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + label: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + status: + $ref: '#/components/schemas/RoleStatus' + type: + $ref: '#/components/schemas/RoleType' + type: object + x-okta-operations: + - alias: addAdminGroupTarget + arguments: + - dest: roleId + src: id + - dest: groupId + parentSrc: id + operationId: addGroupTargetToGroupAdministratorRoleForGroup + - alias: addAppInstanceTargetToAdminRole + arguments: + - dest: roleId + src: id + - dest: groupId + parentSrc: id + operationId: addApplicationInstanceTargetToAppAdminRoleGivenToGroup + - alias: addAppTargetToAdminRole + arguments: + - dest: roleId + src: id + - dest: groupId + parentSrc: id + operationId: addApplicationTargetToAdminRoleGivenToGroup + - alias: addAllAppsAsTargetToRole + arguments: + - dest: roleId + src: id + - dest: userId + parentSrc: id + operationId: addAllAppsAsTargetToRole + - alias: addAppTargetToAppAdminRoleForUser + arguments: + - dest: roleId + src: id + - dest: userId + parentSrc: id + operationId: addApplicationTargetToAppAdminRoleForUser + - alias: addAppTargetToAdminRoleForUser + arguments: + - dest: roleId + src: id + - dest: userId + parentSrc: id + operationId: addApplicationTargetToAdminRoleForUser + x-okta-tags: + - User + RoleAssignmentType: + enum: + - GROUP + - USER + type: string + x-okta-tags: + - Role + RoleStatus: + enum: + - ACTIVE + - INACTIVE + type: string + x-okta-tags: + - User + RoleType: + enum: + - SUPER_ADMIN + - ORG_ADMIN + - APP_ADMIN + - USER_ADMIN + - HELP_DESK_ADMIN + - READ_ONLY_ADMIN + - MOBILE_ADMIN + - API_ACCESS_MANAGEMENT_ADMIN + - REPORT_ADMIN + - GROUP_MEMBERSHIP_ADMIN + type: string + x-okta-tags: + - Role + SamlApplication: + properties: + settings: + $ref: '#/components/schemas/SamlApplicationSettings' + type: object + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + SamlApplicationSettings: + properties: + signOn: + $ref: '#/components/schemas/SamlApplicationSettingsSignOn' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + SamlApplicationSettingsSignOn: + properties: + acsEndpoints: + items: + $ref: '#/components/schemas/AcsEndpoint' + type: array + allowMultipleAcsEndpoints: + type: boolean + assertionSigned: + type: boolean + attributeStatements: + items: + $ref: '#/components/schemas/SamlAttributeStatement' + type: array + audience: + type: string + audienceOverride: + type: string + authnContextClassRef: + type: string + defaultRelayState: + type: string + destination: + type: string + destinationOverride: + type: string + digestAlgorithm: + type: string + honorForceAuthn: + type: boolean + idpIssuer: + type: string + inlineHooks: + items: + $ref: '#/components/schemas/SignOnInlineHook' + type: array + recipient: + type: string + recipientOverride: + type: string + requestCompressed: + type: boolean + responseSigned: + type: boolean + signatureAlgorithm: + type: string + slo: + $ref: '#/components/schemas/SingleLogout' + spCertificate: + $ref: '#/components/schemas/SpCertificate' + spIssuer: + type: string + ssoAcsUrl: + type: string + ssoAcsUrlOverride: + type: string + subjectNameIdFormat: + type: string + subjectNameIdTemplate: + type: string + type: object + x-okta-tags: + - Application + SamlAttributeStatement: + properties: + filterType: + type: string + filterValue: + type: string + name: + type: string + namespace: + type: string + type: + type: string + values: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + SchemeApplicationCredentials: + properties: + password: + $ref: '#/components/schemas/PasswordCredential' + revealPassword: + type: boolean + scheme: + $ref: '#/components/schemas/ApplicationCredentialsScheme' + signing: + $ref: '#/components/schemas/ApplicationCredentialsSigning' + userName: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationCredentials' + x-okta-tags: + - Application + SecurePasswordStoreApplication: + properties: + credentials: + $ref: '#/components/schemas/SchemeApplicationCredentials' + name: + type: object + settings: + $ref: '#/components/schemas/SecurePasswordStoreApplicationSettings' + type: object + x-okta-defined-as: + name: template_sps + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + SecurePasswordStoreApplicationSettings: + properties: + app: + $ref: '#/components/schemas/SecurePasswordStoreApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + SecurePasswordStoreApplicationSettingsApplication: + properties: + optionalField1: + type: string + optionalField1Value: + type: string + optionalField2: + type: string + optionalField2Value: + type: string + optionalField3: + type: string + optionalField3Value: + type: string + passwordField: + type: string + url: + type: string + usernameField: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + SignOnInlineHook: + properties: + id: + type: string + type: object + x-okta-tags: + - Application + SingleLogout: + properties: + enabled: + type: boolean + issuer: + type: string + logoutUrl: + type: string + type: object + x-okta-tags: + - Application + SpCertificate: + properties: + x5c: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + SwaApplication: + properties: + name: + type: object + settings: + $ref: '#/components/schemas/SwaApplicationSettings' + type: object + x-okta-defined-as: + name: template_swa + x-okta-parent: '#/components/schemas/BrowserPluginApplication' + x-okta-tags: + - Application + SwaApplicationSettings: + properties: + app: + $ref: '#/components/schemas/SwaApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + SwaApplicationSettingsApplication: + properties: + buttonField: + type: string + loginUrlRegex: + type: string + passwordField: + type: string + url: + type: string + usernameField: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + SwaThreeFieldApplication: + properties: + name: + type: object + settings: + $ref: '#/components/schemas/SwaThreeFieldApplicationSettings' + type: object + x-okta-defined-as: + name: template_swa3field + x-okta-parent: '#/components/schemas/BrowserPluginApplication' + x-okta-tags: + - Application + SwaThreeFieldApplicationSettings: + properties: + app: + $ref: '#/components/schemas/SwaThreeFieldApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + SwaThreeFieldApplicationSettingsApplication: + properties: + buttonSelector: + type: string + extraFieldSelector: + type: string + extraFieldValue: + type: string + loginUrlRegex: + type: string + passwordSelector: + type: string + targetURL: + type: string + userNameSelector: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + User: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + activated: + format: date-time + readOnly: true + type: string + created: + format: date-time + readOnly: true + type: string + credentials: + $ref: '#/components/schemas/UserCredentials' + id: + readOnly: true + type: string + lastLogin: + format: date-time + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + passwordChanged: + format: date-time + readOnly: true + type: string + profile: + $ref: '#/components/schemas/UserProfile' + status: + $ref: '#/components/schemas/UserStatus' + statusChanged: + format: date-time + readOnly: true + type: string + transitioningToStatus: + $ref: '#/components/schemas/UserStatus' + type: + $ref: '#/components/schemas/UserType' + type: object + x-okta-crud: + - alias: create + arguments: + - dest: user + self: true + operationId: createUser + - alias: read + arguments: [] + operationId: getUser + - alias: update + arguments: + - dest: userId + src: id + - dest: user + self: true + operationId: updateUser + - alias: delete + arguments: + - dest: userId + src: id + - dest: user + self: true + operationId: deactivateOrDeleteUser + x-okta-operations: + - alias: listAppLinks + arguments: + - dest: userId + src: id + operationId: listAppLinks + - alias: changePassword + arguments: + - dest: userId + src: id + operationId: changePassword + - alias: changeRecoveryQuestion + arguments: + - dest: userId + src: id + operationId: changeRecoveryQuestion + - alias: forgotPasswordSetNewPassword + arguments: + - dest: userId + src: id + operationId: forgotPasswordSetNewPassword + - alias: forgotPasswordGenerateOneTimeToken + arguments: + - dest: userId + src: id + operationId: forgotPasswordGenerateOneTimeToken + - alias: assignRole + arguments: + - dest: userId + src: id + operationId: assignRoleToUser + - alias: getRole + arguments: + - dest: userId + src: id + operationId: getUserRole + - alias: removeRole + arguments: + - dest: userId + src: id + operationId: removeRoleFromUser + - alias: listGroupTargets + arguments: + - dest: userId + src: id + operationId: listGroupTargetsForRole + - alias: removeGroupTarget + arguments: + - dest: userId + src: id + operationId: removeGroupTargetFromRole + - alias: addGroupTarget + arguments: + - dest: userId + src: id + operationId: addGroupTargetToRole + - alias: listAssignedRoles + arguments: + - dest: userId + src: id + operationId: listAssignedRolesForUser + - alias: addAllAppsAsTarget + arguments: + - dest: userId + src: id + operationId: addAllAppsAsTargetToRole + - alias: listGroups + arguments: + - dest: userId + src: id + operationId: listUserGroups + - alias: listGrants + arguments: + - dest: userId + src: id + operationId: listUserGrants + - alias: revokeGrants + arguments: + - dest: userId + src: id + operationId: revokeUserGrants + - alias: revokeGrant + arguments: + - dest: userId + src: id + operationId: revokeUserGrant + - alias: revokeGrantsForUserAndClient + arguments: + - dest: userId + src: id + operationId: revokeGrantsForUserAndClient + - alias: listRefreshTokensForUserAndClient + arguments: + - dest: userId + src: id + operationId: listRefreshTokensForUserAndClient + - alias: revokeTokenForUserAndClient + arguments: + - dest: userId + src: id + operationId: revokeTokenForUserAndClient + - alias: getRefreshTokenForUserAndClient + arguments: + - dest: userId + src: id + operationId: getRefreshTokenForUserAndClient + - alias: revokeTokensForUserAndClient + arguments: + - dest: userId + src: id + operationId: revokeTokensForUserAndClient + - alias: listClients + arguments: + - dest: userId + src: id + operationId: listUserClients + - alias: activate + arguments: + - dest: userId + src: id + operationId: activateUser + - alias: reactivate + arguments: + - dest: userId + src: id + operationId: reactivateUser + - alias: deactivate + arguments: + - dest: userId + src: id + operationId: deactivateUser + - alias: suspend + arguments: + - dest: userId + src: id + operationId: suspendUser + - alias: unsuspend + arguments: + - dest: userId + src: id + operationId: unsuspendUser + - alias: resetPassword + arguments: + - dest: userId + src: id + operationId: resetPassword + - alias: expirePassword + arguments: + - dest: userId + src: id + operationId: expirePassword + - alias: expirePasswordAndGetTemporaryPassword + arguments: + - dest: userId + src: id + operationId: expirePasswordAndGetTemporaryPassword + - alias: unlock + arguments: + - dest: userId + src: id + operationId: unlockUser + - alias: resetFactors + arguments: + - dest: userId + src: id + operationId: resetFactors + - alias: deleteFactor + arguments: + - dest: userId + src: id + operationId: deleteFactor + - alias: addToGroup + arguments: + - dest: userId + src: id + description: Adds a user to a group with 'OKTA_GROUP' type + operationId: addUserToGroup + - alias: enrollFactor + arguments: + - dest: userId + src: id + operationId: enrollFactor + - alias: listSupportedFactors + arguments: + - dest: userId + src: id + operationId: listSupportedFactors + - alias: listFactors + arguments: + - dest: userId + src: id + operationId: listFactors + - alias: listSupportedSecurityQuestions + arguments: + - dest: userId + src: id + operationId: listSupportedSecurityQuestions + - alias: getFactor + arguments: + - dest: userId + src: id + operationId: getFactor + - alias: setLinkedObject + arguments: + - dest: associatedUserId + src: id + operationId: setLinkedObjectForUser + - alias: listIdentityProviders + arguments: + - dest: userId + src: id + operationId: listUserIdentityProviders + - alias: getLinkedObjects + arguments: + - dest: userId + src: id + operationId: getLinkedObjectsForUser + - alias: clearSessions + arguments: + - dest: userId + src: id + operationId: clearUserSessions + - alias: removeLinkedObject + arguments: + - dest: userId + src: id + operationId: removeLinkedObjectForUser + x-okta-tags: + - User + UserCredentials: + properties: + password: + $ref: '#/components/schemas/PasswordCredential' + provider: + $ref: '#/components/schemas/AuthenticationProvider' + recovery_question: + $ref: '#/components/schemas/RecoveryQuestionCredential' + type: object + x-okta-tags: + - User + UserProfile: + properties: + city: + type: string + costCenter: + type: string + countryCode: + type: string + department: + type: string + displayName: + type: string + division: + type: string + email: + type: string + employeeNumber: + type: string + firstName: + type: string + honorificPrefix: + type: string + honorificSuffix: + type: string + lastName: + type: string + locale: + type: string + login: + type: string + manager: + type: string + managerId: + type: string + middleName: + type: string + mobilePhone: + type: string + nickName: + type: string + organization: + type: string + postalAddress: + type: string + preferredLanguage: + type: string + primaryPhone: + type: string + profileUrl: + type: string + secondEmail: + type: string + state: + type: string + streetAddress: + type: string + timezone: + type: string + title: + type: string + userType: + type: string + zipCode: + type: string + type: object + x-okta-extensible: true + x-okta-tags: + - User + UserStatus: + enum: + - ACTIVE + - DEPROVISIONED + - LOCKED_OUT + - PASSWORD_EXPIRED + - PROVISIONED + - RECOVERY + - STAGED + - SUSPENDED + type: string + x-okta-tags: + - User + UserType: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + createdBy: + readOnly: true + type: string + default: + readOnly: true + type: boolean + description: + type: string + displayName: + type: string + id: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + lastUpdatedBy: + readOnly: true + type: string + name: + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: userType + self: true + operationId: createUserType + - alias: update + arguments: + - dest: typeId + src: id + - dest: userType + self: true + operationId: updateUserType + - alias: read + arguments: + - dest: typeId + src: id + operationId: getUserType + - alias: delete + arguments: + - dest: typeId + src: id + operationId: deleteUserType + x-okta-operations: + - alias: replaceUserType + arguments: + - dest: roleId + src: id + operationId: replaceUserType + x-okta-tags: + - UserType + WsFederationApplication: + properties: + name: + type: object + settings: + $ref: '#/components/schemas/WsFederationApplicationSettings' + type: object + x-okta-defined-as: + name: template_wsfed + x-okta-parent: '#/components/schemas/Application' + x-okta-tags: + - Application + WsFederationApplicationSettings: + properties: + app: + $ref: '#/components/schemas/WsFederationApplicationSettingsApplication' + type: object + x-okta-parent: '#/components/schemas/ApplicationSettings' + x-okta-tags: + - Application + WsFederationApplicationSettingsApplication: + properties: + attributeStatements: + type: string + audienceRestriction: + type: string + authnContextClassRef: + type: string + groupFilter: + type: string + groupName: + type: string + groupValueFormat: + type: string + nameIDFormat: + type: string + realm: + type: string + siteURL: + type: string + usernameAttribute: + type: string + wReplyOverride: + type: boolean + wReplyURL: + type: string + type: object + x-okta-parent: '#/components/schemas/ApplicationSettingsApplication' + x-okta-tags: + - Application + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + appinstancetargets: + id: okta.group.appinstancetargets + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} + response: + openAPIDocKey: '204' + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} + response: + openAPIDocKey: '204' + name: appinstancetargets + title: appinstancetargets + apps: + id: okta.group.apps + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/groups/{groupId}/apps + response: + mediaType: application/json + openAPIDocKey: '200' + name: apps + title: apps + apptargets: + id: okta.group.apptargets + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName} + response: + openAPIDocKey: '204' + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName} + response: + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps + response: + mediaType: application/json + openAPIDocKey: '200' + name: apptargets + title: apptargets + groups: + id: okta.group.groups + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/groups/{groupId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/groups/{groupId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/groups + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/groups + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/groups/{groupId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: groups + title: groups + grouptargets: + id: okta.group.grouptargets + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId} + response: + openAPIDocKey: '204' + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId} + response: + openAPIDocKey: '204' + list: + operation: + $ref: GET + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId}/targets/groups + response: + mediaType: application/json + openAPIDocKey: '200' + name: grouptargets + title: grouptargets + roles: + id: okta.group.roles + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/groups/{groupId}/roles/{roleId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/groups/{groupId}/roles + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/groups/{groupId}/roles + response: + mediaType: application/json + openAPIDocKey: '200' + name: roles + title: roles + ruleactivations: + id: okta.group.ruleactivations + methods: + delete: + operation: + $ref: POST + path: + $ref: /api/v1/groups/rules/{ruleId}/lifecycle/deactivate + response: + openAPIDocKey: '204' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/groups/rules/{ruleId}/lifecycle/activate + response: + openAPIDocKey: '204' + name: ruleactivations + title: ruleactivations + rules: + id: okta.group.rules + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/groups/rules/{ruleId} + response: + openAPIDocKey: '202' + get: + operation: + $ref: GET + path: + $ref: /api/v1/groups/rules/{ruleId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/groups/rules + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/groups/rules + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/groups/rules/{ruleId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: rules + title: rules + users: + id: okta.group.users + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/groups/{groupId}/users/{userId} + response: + openAPIDocKey: '204' + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/groups/{groupId}/users/{userId} + response: + openAPIDocKey: '204' + list: + operation: + $ref: GET + path: + $ref: /api/v1/groups/{groupId}/users + response: + mediaType: application/json + openAPIDocKey: '200' + name: users + title: users +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/groups: + get: + description: Enumerates groups in your organization with pagination. A subset + of groups can be returned that match a supported filter expression or query. + operationId: listGroups + parameters: + - description: Searches the name property of groups for matching value + in: query + name: q + schema: + type: string + - description: Filter expression for groups + in: query + name: search + schema: + type: string + - description: Specifies the pagination cursor for the next page of groups + in: query + name: after + schema: + type: string + - description: Specifies the number of group results in a page + in: query + name: limit + schema: + default: 10000 + format: int32 + type: integer + - description: If specified, it causes additional metadata to be included in + the response. + in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Group' + type: array + description: Success + security: + - api_token: [] + summary: List Groups + tags: + - Group + post: + description: Adds a new group with `OKTA_GROUP` type to your organization. + operationId: createGroup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + description: Success + security: + - api_token: [] + summary: Add Group + tags: + - Group + x-codegen-request-body-name: group + /api/v1/groups/rules: + get: + description: Lists all group rules for your organization. + operationId: listGroupRules + parameters: + - description: Specifies the number of rule results in a page + in: query + name: limit + schema: + default: 50 + format: int32 + type: integer + - description: Specifies the pagination cursor for the next page of rules + in: query + name: after + schema: + type: string + - description: Specifies the keyword to search fules for + in: query + name: search + schema: + type: string + - description: If specified as `groupIdToGroupNameMap`, then show group names + in: query + name: expand + schema: + type: string + x-okta-added-version: 1.3.0 + x-okta-added-version: 1.3.0 + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/GroupRule' + type: array + description: Success + security: + - api_token: [] + summary: List Group Rules + tags: + - Group + post: + description: Creates a group rule to dynamically add users to the specified + group if they match the condition + operationId: createGroupRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupRule' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GroupRule' + description: Success + security: + - api_token: [] + summary: Create Group Rule + tags: + - Group + x-codegen-request-body-name: groupRule + /api/v1/groups/rules/{ruleId}: + delete: + description: Removes a specific group rule by id from your organization + operationId: deleteGroupRule + parameters: + - in: path + name: ruleId + required: true + schema: + type: string + - description: Indicates whether to keep or remove users from groups assigned + by this rule. + in: query + name: removeUsers + schema: + type: boolean + responses: + '202': + content: {} + description: Accepted + security: + - api_token: [] + summary: Delete a group Rule + tags: + - Group + get: + description: Fetches a specific group rule by id from your organization + operationId: getGroupRule + parameters: + - in: path + name: ruleId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GroupRule' + description: Success + security: + - api_token: [] + summary: Get Group Rule + tags: + - Group + put: + description: Updates a group rule. Only `INACTIVE` rules can be updated. + operationId: updateGroupRule + parameters: + - in: path + name: ruleId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupRule' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GroupRule' + description: Success + security: + - api_token: [] + tags: + - Group + x-codegen-request-body-name: groupRule + /api/v1/groups/rules/{ruleId}/lifecycle/activate: + post: + description: Activates a specific group rule by id from your organization + operationId: activateGroupRule + parameters: + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Activate a group Rule + tags: + - Group + /api/v1/groups/rules/{ruleId}/lifecycle/deactivate: + post: + description: Deactivates a specific group rule by id from your organization + operationId: deactivateGroupRule + parameters: + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Deactivate a group Rule + tags: + - Group + /api/v1/groups/{groupId}: + delete: + description: Removes a group with `OKTA_GROUP` type from your organization. + operationId: deleteGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Remove Group + tags: + - Group + get: + description: Fetches a group from your organization. + operationId: getGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + description: Success + security: + - api_token: [] + summary: List Group Rules + tags: + - Group + put: + description: Updates the profile for a group with `OKTA_GROUP` type from your + organization. + operationId: updateGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + description: Success + security: + - api_token: [] + summary: Update Group + tags: + - Group + x-codegen-request-body-name: group + /api/v1/groups/{groupId}/apps: + get: + description: Enumerates all applications that are assigned to a group. + operationId: listAssignedApplicationsForGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - description: Specifies the pagination cursor for the next page of apps + in: query + name: after + schema: + type: string + - description: Specifies the number of app results for a page + in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Application' + type: array + description: Success + security: + - api_token: [] + summary: List Assigned Applications + tags: + - Group + /api/v1/groups/{groupId}/roles: + get: + description: Success + operationId: listGroupAssignedRoles + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Role' + type: array + description: Success + security: + - api_token: [] + tags: + - Group + post: + description: Assigns a Role to a Group + operationId: assignRoleToGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: query + name: disableNotifications + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AssignRoleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: Success + '201': + content: {} + description: Success + security: + - api_token: [] + tags: + - Group + x-codegen-request-body-name: assignRoleRequest + /api/v1/groups/{groupId}/roles/{roleId}: + delete: + description: Unassigns a Role from a Group + operationId: removeRoleFromGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Group + get: + description: Success + operationId: getRole + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: Success + security: + - api_token: [] + tags: + - Group + /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps: + get: + description: Lists all App targets for an `APP_ADMIN` Role assigned to a Group. + This methods return list may include full Applications or Instances. The response + for an instance will have an `ID` value, while Application will not have an + ID. + operationId: listApplicationTargetsForApplicationAdministratorRoleForGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/CatalogApplication' + type: array + description: Success + security: + - api_token: [] + tags: + - Group + /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}: + delete: + description: Success + operationId: removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: appName + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Group + put: + description: Success + operationId: addApplicationTargetToAdminRoleGivenToGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: appName + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - Group + /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}: + delete: + description: Remove App Instance Target to App Administrator Role given to a + Group + operationId: removeApplicationTargetFromAdministratorRoleGivenToGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: appName + required: true + schema: + type: string + - in: path + name: applicationId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Remove App Instance Target to App Administrator Role given to a Group + tags: + - Group + put: + description: Add App Instance Target to App Administrator Role given to a Group + operationId: addApplicationInstanceTargetToAppAdminRoleGivenToGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: appName + required: true + schema: + type: string + - in: path + name: applicationId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Add App Instance Target to App Administrator Role given to a Group + tags: + - Group + /api/v1/groups/{groupId}/roles/{roleId}/targets/groups: + get: + description: Success + operationId: listGroupTargetsForGroupRole + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Group' + type: array + description: Success + security: + - api_token: [] + tags: + - Group + /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}: + delete: + operationId: removeGroupTargetFromGroupAdministratorRoleGivenToGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: targetGroupId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Group + put: + operationId: addGroupTargetToGroupAdministratorRoleForGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: targetGroupId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Group + /api/v1/groups/{groupId}/users: + get: + description: Enumerates all users that are a member of a group. + operationId: listGroupUsers + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - description: Specifies the pagination cursor for the next page of users + in: query + name: after + schema: + type: string + - description: Specifies the number of user results in a page + in: query + name: limit + schema: + default: 1000 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/User' + type: array + description: Success + security: + - api_token: [] + summary: List Group Members + tags: + - Group + /api/v1/groups/{groupId}/users/{userId}: + delete: + description: Removes a user from a group with 'OKTA_GROUP' type. + operationId: removeUserFromGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Remove User from Group + tags: + - Group + put: + description: Adds a user to a group with 'OKTA_GROUP' type. + operationId: addUserToGroup + parameters: + - in: path + name: groupId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Add User to Group + tags: + - Group +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Group.yaml.sig b/test/registry/src/okta/v1/services/Group.yaml.sig new file mode 100644 index 00000000..b4ad7416 --- /dev/null +++ b/test/registry/src/okta/v1/services/Group.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnNlTb+AKUr9n+enTSr1lx4yexbrTl8GpnL+WDVwOD4vYHv5OasLgf95FzEt3ijz0eCnWnlwnf+qy0pVs5vJWCScHJh8d5Bw== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/GroupSchema.yaml b/test/registry/src/okta/v1/services/GroupSchema.yaml new file mode 100644 index 00000000..c3856c06 --- /dev/null +++ b/test/registry/src/okta/v1/services/GroupSchema.yaml @@ -0,0 +1,336 @@ +components: + schemas: + GroupSchema: + properties: + $schema: + readOnly: true + type: string + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + readOnly: true + type: string + definitions: + $ref: '#/components/schemas/GroupSchemaDefinitions' + description: + type: string + id: + readOnly: true + type: string + lastUpdated: + readOnly: true + type: string + name: + readOnly: true + type: string + properties: + $ref: '#/components/schemas/UserSchemaProperties' + title: + type: string + type: + readOnly: true + type: string + type: object + x-okta-tags: + - GroupSchema + GroupSchemaAttribute: + properties: + description: + type: string + enum: + items: + type: string + type: array + externalName: + type: string + externalNamespace: + type: string + items: + $ref: '#/components/schemas/UserSchemaAttributeItems' + master: + $ref: '#/components/schemas/UserSchemaAttributeMaster' + maxLength: + type: integer + minLength: + type: integer + mutability: + type: string + oneOf: + items: + $ref: '#/components/schemas/UserSchemaAttributeEnum' + type: array + permissions: + items: + $ref: '#/components/schemas/UserSchemaAttributePermission' + type: array + required: + type: boolean + scope: + $ref: '#/components/schemas/UserSchemaAttributeScope' + title: + type: string + type: + $ref: '#/components/schemas/UserSchemaAttributeType' + union: + $ref: '#/components/schemas/UserSchemaAttributeUnion' + unique: + type: string + type: object + x-okta-tags: + - GroupSchema + GroupSchemaBase: + properties: + id: + readOnly: true + type: string + properties: + $ref: '#/components/schemas/GroupSchemaBaseProperties' + required: + items: + type: string + type: array + type: + type: string + type: object + x-okta-tags: + - GroupSchema + GroupSchemaBaseProperties: + properties: + description: + $ref: '#/components/schemas/GroupSchemaAttribute' + name: + $ref: '#/components/schemas/GroupSchemaAttribute' + type: object + x-okta-tags: + - GroupSchema + GroupSchemaCustom: + properties: + id: + readOnly: true + type: string + properties: + additionalProperties: + $ref: '#/components/schemas/GroupSchemaAttribute' + type: object + required: + items: + type: string + type: array + type: + type: string + type: object + x-okta-tags: + - GroupSchema + GroupSchemaDefinitions: + properties: + base: + $ref: '#/components/schemas/GroupSchemaBase' + custom: + $ref: '#/components/schemas/GroupSchemaCustom' + type: object + x-okta-tags: + - GroupSchema + UserSchemaAttributeEnum: + properties: + const: + type: string + title: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeItems: + properties: + enum: + items: + type: string + type: array + oneOf: + items: + $ref: '#/components/schemas/UserSchemaAttributeEnum' + type: array + type: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeMaster: + properties: + priority: + items: + $ref: '#/components/schemas/UserSchemaAttributeMasterPriority' + type: array + type: + $ref: '#/components/schemas/UserSchemaAttributeMasterType' + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeMasterPriority: + properties: + type: + type: string + value: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeMasterType: + enum: + - PROFILE_MASTER + - OKTA + - OVERRIDE + type: string + x-okta-tags: + - UserSchema + UserSchemaAttributePermission: + properties: + action: + type: string + principal: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeScope: + enum: + - SELF + - NONE + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeType: + enum: + - string + - boolean + - number + - integer + - array + type: string + x-okta-tags: + - UserSchema + UserSchemaAttributeUnion: + enum: + - DISABLE + - ENABLE + type: object + x-okta-tags: + - UserSchema + UserSchemaProperties: + properties: + profile: + $ref: '#/components/schemas/UserSchemaPropertiesProfile' + type: object + x-okta-tags: + - UserSchema + UserSchemaPropertiesProfile: + properties: + allOf: + items: + $ref: '#/components/schemas/UserSchemaPropertiesProfileItem' + type: array + type: object + x-okta-tags: + - UserSchema + UserSchemaPropertiesProfileItem: + properties: + $ref: + type: string + type: object + x-okta-tags: + - UserSchema + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + default: + id: okta.groupschema.default + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/meta/schemas/group/default + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: POST + path: + $ref: /api/v1/meta/schemas/group/default + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: default + title: default +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/meta/schemas/group/default: + get: + description: Fetches the group schema + operationId: getGroupSchema + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GroupSchema' + description: successful operation + security: + - api_token: [] + summary: Fetches the group schema + tags: + - GroupSchema + post: + description: Updates, adds ore removes one or more custom Group Profile properties + in the schema + operationId: updateGroupSchema + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupSchema' + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GroupSchema' + description: successful operation + security: + - api_token: [] + summary: Updates, adds ore removes one or more custom Group Profile properties + in the schema + tags: + - GroupSchema + x-codegen-request-body-name: body +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/GroupSchema.yaml.sig b/test/registry/src/okta/v1/services/GroupSchema.yaml.sig new file mode 100644 index 00000000..a4b7d3a5 --- /dev/null +++ b/test/registry/src/okta/v1/services/GroupSchema.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnKDYBoAKUOgZsCI8ciZumDjlVRMCWYdwXZZ+MfD4s6zzUKSuF6QQKtmtShp7PIKLkp/5V6ps77Oxy2ADBdGQXNeFQofl0Bg== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/IdentityProvider.yaml b/test/registry/src/okta/v1/services/IdentityProvider.yaml new file mode 100644 index 00000000..7dac1825 --- /dev/null +++ b/test/registry/src/okta/v1/services/IdentityProvider.yaml @@ -0,0 +1,2400 @@ +components: + schemas: + AppAndInstanceConditionEvaluatorAppOrInstance: + properties: + id: + readOnly: true + type: string + name: + type: string + type: + enum: + - APP_TYPE + - APP + type: string + type: object + x-okta-tags: + - Policy + AppAndInstancePolicyRuleCondition: + properties: + exclude: + items: + $ref: '#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance' + type: array + include: + items: + $ref: '#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance' + type: array + type: object + x-okta-tags: + - Policy + AppInstancePolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + BeforeScheduledActionPolicyRuleCondition: + properties: + duration: + $ref: '#/components/schemas/Duration' + lifecycleAction: + $ref: '#/components/schemas/ScheduledUserLifecycleAction' + type: object + x-okta-tags: + - Policy + ClientPolicyCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + ContextPolicyRuleCondition: + properties: + expression: + type: string + type: object + x-okta-tags: + - Policy + Csr: + properties: + created: + format: date-time + readOnly: true + type: string + csr: + readOnly: true + type: string + id: + readOnly: true + type: string + kty: + readOnly: true + type: string + type: object + x-okta-tags: + - Application + CsrMetadata: + properties: + subject: + $ref: '#/components/schemas/CsrMetadataSubject' + subjectAltNames: + $ref: '#/components/schemas/CsrMetadataSubjectAltNames' + type: object + x-okta-tags: + - Application + CsrMetadataSubject: + properties: + commonName: + type: string + countryName: + type: string + localityName: + type: string + organizationName: + type: string + organizationalUnitName: + type: string + stateOrProvinceName: + type: string + type: object + x-okta-tags: + - Application + CsrMetadataSubjectAltNames: + properties: + dnsNames: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + DevicePolicyRuleCondition: + properties: + migrated: + type: boolean + platform: + $ref: '#/components/schemas/DevicePolicyRuleConditionPlatform' + rooted: + type: boolean + trustLevel: + enum: + - ANY + - TRUSTED + type: string + type: object + x-okta-tags: + - Policy + DevicePolicyRuleConditionPlatform: + properties: + supportedMDMFrameworks: + items: + enum: + - AFW + - SAFE + - NATIVE + type: string + type: array + types: + items: + enum: + - IOS + - ANDROID + - OSX + - WINDOWS + type: string + type: array + type: object + x-okta-tags: + - Policy + Duration: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + GrantTypePolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + GroupCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + GroupPolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + IdentityProvider: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + issuerMode: + enum: + - ORG_URL + - CUSTOM_URL + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + policy: + $ref: '#/components/schemas/IdentityProviderPolicy' + protocol: + $ref: '#/components/schemas/Protocol' + status: + enum: + - ACTIVE + - INACTIVE + type: string + type: + enum: + - SAML2 + - GOOGLE + - FACEBOOK + - LINKEDIN + - MICROSOFT + - OIDC + - OKTA + - IWA + - AgentlessDSSO + - X509 + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: idpTrust + self: true + operationId: createIdentityProvider + - alias: read + arguments: [] + operationId: getIdentityProvider + - alias: update + arguments: + - dest: idpId + src: id + - dest: idpTrust + self: true + operationId: updateIdentityProvider + - alias: delete + arguments: + - dest: idpId + src: id + operationId: deleteIdentityProvider + x-okta-operations: + - alias: listSigningCsrs + arguments: + - dest: idpId + src: id + operationId: listCsrsForIdentityProvider + - alias: generateCsr + arguments: + - dest: idpId + src: id + operationId: generateCsrForIdentityProvider + - alias: deleteSigningCsr + arguments: + - dest: idpId + src: id + operationId: revokeCsrForIdentityProvider + - alias: getSigningCsr + arguments: + - dest: idpId + src: id + operationId: getCsrForIdentityProvider + - alias: listSigningKeys + arguments: + - dest: idpId + src: id + operationId: listIdentityProviderSigningKeys + - alias: generateSigningKey + arguments: + - dest: idpId + src: id + operationId: generateIdentityProviderSigningKey + - alias: getSigningKey + arguments: + - dest: idpId + src: id + operationId: getIdentityProviderSigningKey + - alias: cloneKey + arguments: + - dest: idpId + src: id + operationId: cloneIdentityProviderKey + - alias: activate + arguments: + - dest: idpId + src: id + operationId: activateIdentityProvider + - alias: deactivate + arguments: + - dest: idpId + src: id + operationId: deactivateIdentityProvider + - alias: listUsers + arguments: + - dest: idpId + src: id + operationId: listIdentityProviderApplicationUsers + - alias: unlinkUser + arguments: + - dest: idpId + src: id + operationId: unlinkUserFromIdentityProvider + - alias: getUser + arguments: + - dest: idpId + src: id + operationId: getIdentityProviderApplicationUser + - alias: linkUser + arguments: + - dest: idpId + src: id + operationId: linkUserToIdentityProvider + - alias: listSocialAuthTokens + arguments: + - dest: idpId + src: id + operationId: listSocialAuthTokens + x-okta-tags: + - IdentityProvider + IdentityProviderApplicationUser: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + type: string + externalId: + type: string + id: + readOnly: true + type: string + lastUpdated: + type: string + profile: + additionalProperties: + properties: {} + type: object + type: object + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderCredentials: + properties: + client: + $ref: '#/components/schemas/IdentityProviderCredentialsClient' + signing: + $ref: '#/components/schemas/IdentityProviderCredentialsSigning' + trust: + $ref: '#/components/schemas/IdentityProviderCredentialsTrust' + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderCredentialsClient: + properties: + client_id: + type: string + client_secret: + type: string + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderCredentialsSigning: + properties: + kid: + type: string + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderCredentialsTrust: + properties: + audience: + type: string + issuer: + type: string + kid: + type: string + revocation: + enum: + - CRL + - DELTA_CRL + - OCSP + type: string + revocationCacheLifetime: + type: integer + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderPolicy: + properties: + accountLink: + $ref: '#/components/schemas/PolicyAccountLink' + maxClockSkew: + type: integer + provisioning: + $ref: '#/components/schemas/Provisioning' + subject: + $ref: '#/components/schemas/PolicySubject' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + IdentityProviderPolicyRuleCondition: + properties: + idpIds: + items: + type: string + type: array + provider: + enum: + - ANY + - OKTA + - SPECIFIC_IDP + type: string + type: object + x-okta-tags: + - Policy + InactivityPolicyRuleCondition: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + JsonWebKey: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + alg: + type: string + created: + format: date-time + type: string + e: + type: string + expiresAt: + format: date-time + type: string + key_ops: + items: + type: string + type: array + kid: + type: string + kty: + type: string + lastUpdated: + format: date-time + type: string + n: + type: string + status: + type: string + use: + type: string + x5c: + items: + type: string + type: array + x5t: + type: string + x5t#S256: + type: string + x5u: + type: string + type: object + x-okta-tags: + - Application + LifecycleExpirationPolicyRuleCondition: + properties: + lifecycleStatus: + type: string + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + MDMEnrollmentPolicyRuleCondition: + properties: + blockNonSafeAndroid: + type: boolean + enrollment: + enum: + - OMM + - ANY_OR_NONE + type: string + type: object + x-okta-tags: + - Policy + OAuth2ScopesMediationPolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + OAuthAuthorizationPolicy: + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + OktaSignOnPolicy: + properties: + conditions: + $ref: '#/components/schemas/OktaSignOnPolicyConditions' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + OktaSignOnPolicyConditions: + properties: + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleConditions' + x-okta-tags: + - Policy + PasswordDictionary: + properties: + common: + $ref: '#/components/schemas/PasswordDictionaryCommon' + type: object + x-okta-tags: + - Policy + PasswordDictionaryCommon: + properties: + exclude: + default: false + type: boolean + type: object + x-okta-tags: + - Policy + PasswordExpirationPolicyRuleCondition: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicy: + properties: + conditions: + $ref: '#/components/schemas/PasswordPolicyConditions' + settings: + $ref: '#/components/schemas/PasswordPolicySettings' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + PasswordPolicyAuthenticationProviderCondition: + properties: + include: + items: + type: string + type: array + provider: + enum: + - ACTIVE_DIRECTORY + - ANY + - LDAP + - OKTA + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyConditions: + properties: + authProvider: + $ref: '#/components/schemas/PasswordPolicyAuthenticationProviderCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleConditions' + x-okta-tags: + - Policy + PasswordPolicyDelegationSettings: + properties: + options: + $ref: '#/components/schemas/PasswordPolicyDelegationSettingsOptions' + type: object + x-okta-tags: + - Policy + PasswordPolicyDelegationSettingsOptions: + properties: + skipUnlock: + type: boolean + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettings: + properties: + age: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsAge' + complexity: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsComplexity' + lockout: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsLockout' + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsAge: + properties: + expireWarnDays: + type: integer + historyCount: + type: integer + maxAgeDays: + type: integer + minAgeMinutes: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsComplexity: + properties: + dictionary: + $ref: '#/components/schemas/PasswordDictionary' + excludeAttributes: + items: + type: string + type: array + excludeUsername: + default: true + type: boolean + minLength: + type: integer + minLowerCase: + type: integer + minNumber: + type: integer + minSymbol: + type: integer + minUpperCase: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsLockout: + properties: + autoUnlockMinutes: + type: integer + maxAttempts: + type: integer + showLockoutFailures: + type: boolean + userLockoutNotificationChannels: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmail: + properties: + properties: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmailProperties' + status: + enum: + - ACTIVE + - INACTIVE + readOnly: true + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmailProperties: + properties: + recoveryToken: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmailRecoveryToken' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmailRecoveryToken: + properties: + tokenLifetimeMinutes: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryFactorSettings: + properties: + status: + default: INACTIVE + enum: + - ACTIVE + - INACTIVE + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryFactors: + properties: + okta_call: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactorSettings' + okta_email: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmail' + okta_sms: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactorSettings' + recovery_question: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestion' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestion: + properties: + properties: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestionProperties' + status: + enum: + - ACTIVE + - INACTIVE + readOnly: true + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestionComplexity: + properties: + minLength: + readOnly: true + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestionProperties: + properties: + complexity: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestionComplexity' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoverySettings: + properties: + factors: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactors' + type: object + x-okta-tags: + - Policy + PasswordPolicySettings: + properties: + delegation: + $ref: '#/components/schemas/PasswordPolicyDelegationSettings' + password: + $ref: '#/components/schemas/PasswordPolicyPasswordSettings' + recovery: + $ref: '#/components/schemas/PasswordPolicyRecoverySettings' + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatform: + properties: + os: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystem' + type: + enum: + - DESKTOP + - MOBILE + - OTHER + - ANY + type: string + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatformOperatingSystem: + properties: + expression: + type: string + type: + enum: + - ANDROID + - IOS + - WINDOWS + - OSX + - OTHER + - ANY + type: string + version: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion' + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatformOperatingSystemVersion: + properties: + matchType: + enum: + - EXPRESSION + - SEMVER + type: string + value: + type: string + type: object + x-okta-tags: + - Policy + PlatformPolicyRuleCondition: + properties: + exclude: + items: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatform' + type: array + include: + items: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatform' + type: array + type: object + x-okta-tags: + - Policy + Policy: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + conditions: + $ref: '#/components/schemas/PolicyRuleConditions' + created: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + priority: + type: integer + status: + enum: + - ACTIVE + - INACTIVE + type: string + system: + type: boolean + type: + $ref: '#/components/schemas/PolicyType' + type: object + x-okta-crud: + - alias: read + arguments: + - dest: policyId + src: id + operationId: getPolicy + - alias: update + arguments: + - dest: policyId + src: id + - dest: policy + self: true + operationId: updatePolicy + - alias: delete + arguments: + - dest: policyId + src: id + operationId: deletePolicy + x-okta-operations: + - alias: activate + arguments: + - dest: policyId + src: id + operationId: activatePolicy + - alias: deactivate + arguments: + - dest: policyId + src: id + operationId: deactivatePolicy + - alias: listPolicyRules + arguments: + - dest: policyId + src: id + operationId: listPolicyRules + - alias: createRule + arguments: + - dest: policyId + src: id + operationId: createPolicyRule + - alias: getPolicyRule + arguments: + - dest: policyId + src: id + operationId: getPolicyRule + x-okta-tags: + - Policy + x-openapi-v3-discriminator: + mapping: + IDP_DISCOVERY: '#/components/schemas/IdentityProviderPolicy' + OAUTH_AUTHORIZATION_POLICY: '#/components/schemas/OAuthAuthorizationPolicy' + OKTA_SIGN_ON: '#/components/schemas/OktaSignOnPolicy' + PASSWORD: '#/components/schemas/PasswordPolicy' + propertyName: type + PolicyAccountLink: + properties: + action: + enum: + - AUTO + - DISABLED + type: string + filter: + $ref: '#/components/schemas/PolicyAccountLinkFilter' + type: object + x-okta-tags: + - Policy + PolicyAccountLinkFilter: + properties: + groups: + $ref: '#/components/schemas/PolicyAccountLinkFilterGroups' + type: object + x-okta-tags: + - Policy + PolicyAccountLinkFilterGroups: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PolicyNetworkCondition: + properties: + connection: + enum: + - ANYWHERE + - ZONE + type: string + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PolicyPeopleCondition: + properties: + groups: + $ref: '#/components/schemas/GroupCondition' + users: + $ref: '#/components/schemas/UserCondition' + type: object + x-okta-tags: + - Policy + PolicyRuleAuthContextCondition: + properties: + authType: + enum: + - ANY + - RADIUS + type: string + type: object + x-okta-tags: + - Policy + PolicyRuleConditions: + properties: + app: + $ref: '#/components/schemas/AppAndInstancePolicyRuleCondition' + apps: + $ref: '#/components/schemas/AppInstancePolicyRuleCondition' + authContext: + $ref: '#/components/schemas/PolicyRuleAuthContextCondition' + authProvider: + $ref: '#/components/schemas/PasswordPolicyAuthenticationProviderCondition' + beforeScheduledAction: + $ref: '#/components/schemas/BeforeScheduledActionPolicyRuleCondition' + clients: + $ref: '#/components/schemas/ClientPolicyCondition' + context: + $ref: '#/components/schemas/ContextPolicyRuleCondition' + device: + $ref: '#/components/schemas/DevicePolicyRuleCondition' + grantTypes: + $ref: '#/components/schemas/GrantTypePolicyRuleCondition' + groups: + $ref: '#/components/schemas/GroupPolicyRuleCondition' + identityProvider: + $ref: '#/components/schemas/IdentityProviderPolicyRuleCondition' + mdmEnrollment: + $ref: '#/components/schemas/MDMEnrollmentPolicyRuleCondition' + network: + $ref: '#/components/schemas/PolicyNetworkCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + platform: + $ref: '#/components/schemas/PlatformPolicyRuleCondition' + risk: + $ref: '#/components/schemas/RiskPolicyRuleCondition' + riskScore: + $ref: '#/components/schemas/RiskScorePolicyRuleCondition' + scopes: + $ref: '#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition' + userIdentifier: + $ref: '#/components/schemas/UserIdentifierPolicyRuleCondition' + userStatus: + $ref: '#/components/schemas/UserStatusPolicyRuleCondition' + users: + $ref: '#/components/schemas/UserPolicyRuleCondition' + type: object + x-okta-tags: + - Policy + PolicySubject: + properties: + filter: + type: string + format: + items: + type: string + type: array + matchAttribute: + type: string + matchType: + $ref: '#/components/schemas/PolicySubjectMatchType' + userNameTemplate: + $ref: '#/components/schemas/PolicyUserNameTemplate' + type: object + x-okta-tags: + - Policy + PolicySubjectMatchType: + enum: + - USERNAME + - EMAIL + - USERNAME_OR_EMAIL + - CUSTOM_ATTRIBUTE + type: string + x-okta-tags: + - Policy + PolicyType: + enum: + - OAUTH_AUTHORIZATION_POLICY + - OKTA_SIGN_ON + - PASSWORD + - IDP_DISCOVERY + type: string + x-okta-tags: + - Policy + PolicyUserNameTemplate: + properties: + template: + type: string + type: object + x-okta-tags: + - Policy + Protocol: + properties: + algorithms: + $ref: '#/components/schemas/ProtocolAlgorithms' + credentials: + $ref: '#/components/schemas/IdentityProviderCredentials' + endpoints: + $ref: '#/components/schemas/ProtocolEndpoints' + issuer: + $ref: '#/components/schemas/ProtocolEndpoint' + relayState: + $ref: '#/components/schemas/ProtocolRelayState' + scopes: + items: + type: string + type: array + settings: + $ref: '#/components/schemas/ProtocolSettings' + type: + enum: + - SAML2 + - OIDC + - OAUTH2 + - MTLS + type: string + type: object + x-okta-tags: + - IdentityProvider + ProtocolAlgorithmType: + properties: + signature: + $ref: '#/components/schemas/ProtocolAlgorithmTypeSignature' + type: object + x-okta-tags: + - IdentityProvider + ProtocolAlgorithmTypeSignature: + properties: + algorithm: + type: string + scope: + enum: + - RESPONSE + - TOKEN + - ANY + - REQUEST + - NONE + type: string + type: object + x-okta-tags: + - IdentityProvider + ProtocolAlgorithms: + properties: + request: + $ref: '#/components/schemas/ProtocolAlgorithmType' + response: + $ref: '#/components/schemas/ProtocolAlgorithmType' + type: object + x-okta-tags: + - IdentityProvider + ProtocolEndpoint: + properties: + binding: + enum: + - HTTP-POST + - HTTP-REDIRECT + type: string + destination: + type: string + type: + enum: + - INSTANCE + - ORG + type: string + url: + type: string + type: object + x-okta-tags: + - IdentityProvider + ProtocolEndpoints: + properties: + acs: + $ref: '#/components/schemas/ProtocolEndpoint' + authorization: + $ref: '#/components/schemas/ProtocolEndpoint' + jwks: + $ref: '#/components/schemas/ProtocolEndpoint' + metadata: + $ref: '#/components/schemas/ProtocolEndpoint' + slo: + $ref: '#/components/schemas/ProtocolEndpoint' + sso: + $ref: '#/components/schemas/ProtocolEndpoint' + token: + $ref: '#/components/schemas/ProtocolEndpoint' + userInfo: + $ref: '#/components/schemas/ProtocolEndpoint' + type: object + x-okta-tags: + - IdentityProvider + ProtocolRelayState: + properties: + format: + $ref: '#/components/schemas/ProtocolRelayStateFormat' + type: object + x-okta-tags: + - IdentityProvider + ProtocolRelayStateFormat: + enum: + - OPAQUE + - FROM_URL + type: string + x-okta-tags: + - IdentityProvider + ProtocolSettings: + properties: + nameFormat: + type: string + type: object + x-okta-tags: + - IdentityProvider + Provisioning: + properties: + action: + enum: + - AUTO + - CALLOUT + - DISABLED + type: string + conditions: + $ref: '#/components/schemas/ProvisioningConditions' + groups: + $ref: '#/components/schemas/ProvisioningGroups' + profileMaster: + type: boolean + type: object + x-okta-tags: + - IdentityProvider + ProvisioningConditions: + properties: + deprovisioned: + $ref: '#/components/schemas/ProvisioningDeprovisionedCondition' + suspended: + $ref: '#/components/schemas/ProvisioningSuspendedCondition' + type: object + x-okta-tags: + - IdentityProvider + ProvisioningDeprovisionedCondition: + properties: + action: + enum: + - NONE + - REACTIVATE + type: string + type: object + x-okta-tags: + - IdentityProvider + ProvisioningGroups: + properties: + action: + enum: + - NONE + - APPEND + - SYNC + - ASSIGN + type: string + assignments: + items: + type: string + type: array + filter: + items: + type: string + type: array + sourceAttributeName: + type: string + type: object + x-okta-tags: + - IdentityProvider + ProvisioningSuspendedCondition: + properties: + action: + enum: + - NONE + - UNSUSPEND + type: string + type: object + x-okta-tags: + - IdentityProvider + RiskPolicyRuleCondition: + properties: + behaviors: + items: + type: string + type: array + uniqueItems: true + type: object + x-okta-tags: + - Policy + RiskScorePolicyRuleCondition: + properties: + level: + type: string + type: object + x-okta-tags: + - Policy + ScheduledUserLifecycleAction: + properties: + status: + enum: + - ACTIVE + - INACTIVE + - PENDING + - DELETED + - EXPIRED_PASSWORD + - ACTIVATING + - SUSPENDED + - DELETING + type: string + type: object + x-okta-tags: + - Policy + SocialAuthToken: + properties: + expiresAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + scopes: + items: + type: string + type: array + token: + type: string + tokenAuthScheme: + type: string + tokenType: + type: string + type: object + x-okta-tags: + - IdentityProvider + UserCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + UserIdentifierConditionEvaluatorPattern: + properties: + matchType: + enum: + - SUFFIX + - EXPRESSION + - STARTS_WITH + - EQUALS + - CONTAINS + type: string + value: + type: string + type: object + x-okta-tags: + - Policy + UserIdentifierPolicyRuleCondition: + properties: + attribute: + type: string + patterns: + items: + $ref: '#/components/schemas/UserIdentifierConditionEvaluatorPattern' + type: array + type: + enum: + - IDENTIFIER + - ATTRIBUTE + type: string + type: object + x-okta-tags: + - Policy + UserIdentityProviderLinkRequest: + properties: + externalId: + type: string + type: object + x-okta-tags: + - Policy + UserLifecycleAttributePolicyRuleCondition: + properties: + attributeName: + type: string + matchingValue: + type: string + type: object + x-okta-tags: + - Policy + UserPolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + inactivity: + $ref: '#/components/schemas/InactivityPolicyRuleCondition' + include: + items: + type: string + type: array + lifecycleExpiration: + $ref: '#/components/schemas/LifecycleExpirationPolicyRuleCondition' + passwordExpiration: + $ref: '#/components/schemas/PasswordExpirationPolicyRuleCondition' + userLifecycleAttribute: + $ref: '#/components/schemas/UserLifecycleAttributePolicyRuleCondition' + type: object + x-okta-tags: + - Policy + UserStatusPolicyRuleCondition: + properties: + value: + enum: + - ACTIVE + - INACTIVE + - PENDING + - DELETED + - EXPIRED_PASSWORD + - ACTIVATING + - SUSPENDED + - DELETING + type: string + type: object + x-okta-tags: + - Policy + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + csrs: + id: okta.identityprovider.csrs + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/idps/{idpId}/credentials/csrs/{csrId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/idps/{idpId}/credentials/csrs/{csrId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/idps/{idpId}/credentials/csrs + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '201' + list: + operation: + $ref: GET + path: + $ref: /api/v1/idps/{idpId}/credentials/csrs + response: + mediaType: application/json + openAPIDocKey: '200' + name: csrs + title: csrs + idpkeys: + id: okta.identityprovider.idpkeys + methods: + clone: + operation: + $ref: POST + path: + $ref: /api/v1/idps/{idpId}/credentials/keys/{keyId}/clone + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: GET + path: + $ref: /api/v1/idps/{idpId}/credentials/keys/{keyId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/idps/{idpId}/credentials/keys/generate + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/idps/{idpId}/credentials/keys + response: + mediaType: application/json + openAPIDocKey: '200' + name: idpkeys + title: idpkeys + idps: + id: okta.identityprovider.idps + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/idps/{idpId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/idps/{idpId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/idps/{idpId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/idps/{idpId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/idps + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/idps + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/idps/{idpId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: idps + title: idps + keys: + id: okta.identityprovider.keys + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/idps/credentials/keys/{keyId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/idps/credentials/keys/{keyId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/idps/credentials/keys + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/idps/credentials/keys + response: + mediaType: application/json + openAPIDocKey: '200' + name: keys + title: keys + users: + id: okta.identityprovider.users + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/idps/{idpId}/users/{userId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/idps/{idpId}/users/{userId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/idps/{idpId}/users/{userId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/idps/{idpId}/users + response: + mediaType: application/json + openAPIDocKey: '200' + name: users + title: users + usertokens: + id: okta.identityprovider.usertokens + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/idps/{idpId}/users/{userId}/credentials/tokens + response: + mediaType: application/json + openAPIDocKey: '200' + name: usertokens + title: usertokens +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/idps: + get: + description: Enumerates IdPs in your organization with pagination. A subset + of IdPs can be returned that match a supported filter expression or query. + operationId: listIdentityProviders + parameters: + - description: Searches the name property of IdPs for matching value + in: query + name: q + schema: + type: string + - description: Specifies the pagination cursor for the next page of IdPs + in: query + name: after + schema: + type: string + - description: Specifies the number of IdP results in a page + in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + - description: Filters IdPs by type + in: query + name: type + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/IdentityProvider' + type: array + description: Success + security: + - api_token: [] + summary: List Identity Providers + tags: + - IdentityProvider + post: + description: Adds a new IdP to your organization. + operationId: createIdentityProvider + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProvider' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProvider' + description: Success + security: + - api_token: [] + summary: Add Identity Provider + tags: + - IdentityProvider + x-codegen-request-body-name: identityProvider + /api/v1/idps/credentials/keys: + get: + description: Enumerates IdP key credentials. + operationId: listIdentityProviderKeys + parameters: + - description: Specifies the pagination cursor for the next page of keys + in: query + name: after + schema: + type: string + - description: Specifies the number of key results in a page + in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/JsonWebKey' + type: array + description: Success + security: + - api_token: [] + summary: List Keys + tags: + - IdentityProvider + post: + description: Adds a new X.509 certificate credential to the IdP key store. + operationId: createIdentityProviderKey + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Success + security: + - api_token: [] + summary: Add X.509 Certificate Public Key + tags: + - IdentityProvider + x-codegen-request-body-name: jsonWebKey + /api/v1/idps/credentials/keys/{keyId}: + delete: + description: Deletes a specific IdP Key Credential by `kid` if it is not currently + being used by an Active or Inactive IdP. + operationId: deleteIdentityProviderKey + parameters: + - in: path + name: keyId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Delete Key + tags: + - IdentityProvider + get: + description: Gets a specific IdP Key Credential by `kid` + operationId: getIdentityProviderKey + parameters: + - in: path + name: keyId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Success + security: + - api_token: [] + summary: Get Key + tags: + - IdentityProvider + /api/v1/idps/{idpId}: + delete: + description: Removes an IdP from your organization. + operationId: deleteIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Delete Identity Provider + tags: + - IdentityProvider + get: + description: Fetches an IdP by `id`. + operationId: getIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProvider' + description: Success + security: + - api_token: [] + summary: Get Identity Provider + tags: + - IdentityProvider + put: + description: Updates the configuration for an IdP. + operationId: updateIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProvider' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProvider' + description: Success + security: + - api_token: [] + summary: Update Identity Provider + tags: + - IdentityProvider + x-codegen-request-body-name: identityProvider + /api/v1/idps/{idpId}/credentials/csrs: + get: + description: Enumerates Certificate Signing Requests for an IdP + operationId: listCsrsForIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Csr' + type: array + description: Success + security: + - api_token: [] + summary: List Certificate Signing Requests for IdP + tags: + - IdentityProvider + post: + description: Generates a new key pair and returns a Certificate Signing Request + for it. + operationId: generateCsrForIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CsrMetadata' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Csr' + description: Created + security: + - api_token: [] + summary: Generate Certificate Signing Request for IdP + tags: + - IdentityProvider + x-codegen-request-body-name: metadata + /api/v1/idps/{idpId}/credentials/csrs/{csrId}: + delete: + description: Revoke a Certificate Signing Request and delete the key pair from + the IdP + operationId: revokeCsrForIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: csrId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - IdentityProvider + get: + description: Gets a specific Certificate Signing Request model by id + operationId: getCsrForIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: csrId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Csr' + description: Success + security: + - api_token: [] + tags: + - IdentityProvider + /api/v1/idps/{idpId}/credentials/csrs/{csrId}/lifecycle/publish: + post: + description: Update the Certificate Signing Request with a signed X.509 certificate + and add it into the signing key credentials for the IdP. + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: csrId + required: true + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Created + security: + - api_token: [] + tags: + - IdentityProvider + x-okta-multi-operation: + - consumes: + - application/x-x509-ca-cert + encoding: base64 + operationId: publishCerCertForIdentityProvider + parameters: + - in: body + name: certificate + required: true + type: string + - consumes: + - application/x-x509-ca-cert + operationId: publishBinaryCerCertForIdentityProvider + parameters: + - format: binary + in: body + name: certificate + required: true + type: string + - consumes: + - application/pkix-cert + encoding: base64 + operationId: publishDerCertForIdentityProvider + parameters: + - in: body + name: certificate + required: true + type: string + - consumes: + - application/pkix-cert + operationId: publishBinaryDerCertForIdentityProvider + parameters: + - format: binary + in: body + name: certificate + required: true + type: string + - consumes: + - application/x-pem-file + operationId: publishBinaryPemCertForIdentityProvider + parameters: + - format: binary + in: body + name: certificate + required: true + type: string + /api/v1/idps/{idpId}/credentials/keys: + get: + description: Enumerates signing key credentials for an IdP + operationId: listIdentityProviderSigningKeys + parameters: + - in: path + name: idpId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/JsonWebKey' + type: array + description: Success + security: + - api_token: [] + summary: List Signing Key Credentials for IdP + tags: + - IdentityProvider + /api/v1/idps/{idpId}/credentials/keys/generate: + post: + description: Generates a new X.509 certificate for an IdP signing key credential + to be used for signing assertions sent to the IdP + operationId: generateIdentityProviderSigningKey + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - description: expiry of the IdP Key Credential + in: query + name: validityYears + required: true + schema: + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Success + security: + - api_token: [] + summary: Generate New IdP Signing Key Credential + tags: + - IdentityProvider + /api/v1/idps/{idpId}/credentials/keys/{keyId}: + get: + description: Gets a specific IdP Key Credential by `kid` + operationId: getIdentityProviderSigningKey + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: keyId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Success + security: + - api_token: [] + summary: Get Signing Key Credential for IdP + tags: + - IdentityProvider + /api/v1/idps/{idpId}/credentials/keys/{keyId}/clone: + post: + description: Clones a X.509 certificate for an IdP signing key credential from + a source IdP to target IdP + operationId: cloneIdentityProviderKey + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: keyId + required: true + schema: + type: string + - in: query + name: targetIdpId + required: true + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/JsonWebKey' + description: Created + security: + - api_token: [] + summary: Clone Signing Key Credential for IdP + tags: + - IdentityProvider + /api/v1/idps/{idpId}/lifecycle/activate: + post: + description: Activates an inactive IdP. + operationId: activateIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProvider' + description: Success + security: + - api_token: [] + summary: Activate Identity Provider + tags: + - IdentityProvider + /api/v1/idps/{idpId}/lifecycle/deactivate: + post: + description: Deactivates an active IdP. + operationId: deactivateIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProvider' + description: Success + security: + - api_token: [] + summary: Deactivate Identity Provider + tags: + - IdentityProvider + /api/v1/idps/{idpId}/users: + get: + description: Find all the users linked to an identity provider + operationId: listIdentityProviderApplicationUsers + parameters: + - in: path + name: idpId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/IdentityProviderApplicationUser' + type: array + description: Success + security: + - api_token: [] + summary: Find Users + tags: + - IdentityProvider + /api/v1/idps/{idpId}/users/{userId}: + delete: + description: Removes the link between the Okta user and the IdP user. + operationId: unlinkUserFromIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Unlink User from IdP + tags: + - IdentityProvider + get: + description: Fetches a linked IdP user by ID + operationId: getIdentityProviderApplicationUser + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProviderApplicationUser' + description: Success + security: + - api_token: [] + tags: + - IdentityProvider + post: + description: Links an Okta user to an existing Social Identity Provider. This + does not support the SAML2 Identity Provider Type + operationId: linkUserToIdentityProvider + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentityProviderLinkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityProviderApplicationUser' + description: Success + security: + - api_token: [] + summary: Link a user to a Social IdP without a transaction + tags: + - IdentityProvider + x-codegen-request-body-name: userIdentityProviderLinkRequest + /api/v1/idps/{idpId}/users/{userId}/credentials/tokens: + get: + description: Fetches the tokens minted by the Social Authentication Provider + when the user authenticates with Okta via Social Auth. + operationId: listSocialAuthTokens + parameters: + - in: path + name: idpId + required: true + schema: + type: string + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SocialAuthToken' + type: array + description: Success + security: + - api_token: [] + summary: Social Authentication Token Operation + tags: + - IdentityProvider +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/IdentityProvider.yaml.sig b/test/registry/src/okta/v1/services/IdentityProvider.yaml.sig new file mode 100644 index 00000000..d7cd0f13 --- /dev/null +++ b/test/registry/src/okta/v1/services/IdentityProvider.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnL4DzIAKULrk7zOG6p/9CzSej0vw+bohDgSimA1K6JSBinMd6Nxj3IcCGgXNw7U/SSQv9UGB2xeCg8exZSFjUb1WOgJfCCg== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/InlineHook.yaml b/test/registry/src/okta/v1/services/InlineHook.yaml new file mode 100644 index 00000000..74e2de00 --- /dev/null +++ b/test/registry/src/okta/v1/services/InlineHook.yaml @@ -0,0 +1,458 @@ +components: + schemas: + InlineHook: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + channel: + $ref: '#/components/schemas/InlineHookChannel' + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + status: + $ref: '#/components/schemas/InlineHookStatus' + type: + $ref: '#/components/schemas/InlineHookType' + version: + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: inlineHook + self: true + operationId: createInlineHook + - alias: read + arguments: [] + operationId: getInlineHook + - alias: update + arguments: + - dest: inlineHookId + src: id + - dest: inlineHook + self: true + operationId: updateInlineHook + - alias: delete + arguments: + - dest: inlineHookId + src: id + operationId: deleteInlineHook + x-okta-operations: + - alias: activate + arguments: + - dest: inlineHookId + src: id + operationId: activateInlineHook + - alias: deactivate + arguments: + - dest: inlineHookId + src: id + operationId: deactivateInlineHook + - alias: execute + arguments: + - dest: inlineHookId + src: id + operationId: executeInlineHook + x-okta-tags: + - InlineHook + InlineHookChannel: + properties: + config: + $ref: '#/components/schemas/InlineHookChannelConfig' + type: + enum: + - HTTP + type: string + version: + type: string + type: object + x-okta-tags: + - InlineHook + InlineHookChannelConfig: + properties: + authScheme: + $ref: '#/components/schemas/InlineHookChannelConfigAuthScheme' + headers: + items: + $ref: '#/components/schemas/InlineHookChannelConfigHeaders' + type: array + method: + type: string + uri: + type: string + type: object + x-okta-tags: + - InlineHook + InlineHookChannelConfigAuthScheme: + properties: + key: + type: string + type: + type: string + value: + type: string + type: object + x-okta-tags: + - InlineHook + InlineHookChannelConfigHeaders: + properties: + key: + type: string + value: + type: string + type: object + x-okta-tags: + - InlineHook + InlineHookPayload: + type: object + x-okta-extensible: true + x-okta-tags: + - InlineHook + InlineHookResponse: + properties: + commands: + items: + $ref: '#/components/schemas/InlineHookResponseCommands' + type: array + type: object + x-okta-tags: + - InlineHook + InlineHookResponseCommandValue: + properties: + op: + type: string + path: + type: string + value: + type: string + type: object + x-okta-tags: + - InlineHook + InlineHookResponseCommands: + properties: + type: + type: string + value: + items: + $ref: '#/components/schemas/InlineHookResponseCommandValue' + type: array + type: object + x-okta-tags: + - InlineHook + InlineHookStatus: + enum: + - ACTIVE + - INACTIVE + type: string + x-okta-tags: + - InlineHook + InlineHookType: + enum: + - com.okta.oauth2.tokens.transform + - com.okta.import.transform + - com.okta.saml.tokens.transform + - com.okta.user.pre-registration + - com.okta.user.credential.password.import + type: string + x-okta-tags: + - InlineHook + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + idps: + id: okta.inlinehook.idps + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/inlineHooks/{inlineHookId} + response: + openAPIDocKey: '204' + execute: + operation: + $ref: POST + path: + $ref: /api/v1/inlineHooks/{inlineHookId}/execute + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: GET + path: + $ref: /api/v1/inlineHooks/{inlineHookId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/inlineHooks + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/inlineHooks + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/inlineHooks/{inlineHookId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: idps + title: idps +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/inlineHooks: + get: + description: Success + operationId: listInlineHooks + parameters: + - in: query + name: type + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/InlineHook' + type: array + description: Success + security: + - api_token: [] + tags: + - InlineHook + post: + description: Success + operationId: createInlineHook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHook' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHook' + description: Success + security: + - api_token: [] + tags: + - InlineHook + x-codegen-request-body-name: inlineHook + /api/v1/inlineHooks/{inlineHookId}: + delete: + description: Deletes the Inline Hook matching the provided id. Once deleted, + the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks + with a status of INACTIVE are eligible for deletion. + operationId: deleteInlineHook + parameters: + - in: path + name: inlineHookId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - InlineHook + get: + description: Gets an inline hook by ID + operationId: getInlineHook + parameters: + - in: path + name: inlineHookId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHook' + description: Success + security: + - api_token: [] + tags: + - InlineHook + put: + description: Updates an inline hook by ID + operationId: updateInlineHook + parameters: + - in: path + name: inlineHookId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHook' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHook' + description: Success + security: + - api_token: [] + tags: + - InlineHook + x-codegen-request-body-name: inlineHook + /api/v1/inlineHooks/{inlineHookId}/execute: + post: + description: Executes the Inline Hook matching the provided inlineHookId using + the request body as the input. This will send the provided data through the + Channel and return a response if it matches the correct data contract. This + execution endpoint should only be used for testing purposes. + operationId: executeInlineHook + parameters: + - in: path + name: inlineHookId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHookPayload' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHookResponse' + description: Success + security: + - api_token: [] + tags: + - InlineHook + x-codegen-request-body-name: payloadData + /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate: + post: + description: Activates the Inline Hook matching the provided id + operationId: activateInlineHook + parameters: + - in: path + name: inlineHookId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHook' + description: Success + security: + - api_token: [] + tags: + - InlineHook + /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate: + post: + description: Deactivates the Inline Hook matching the provided id + operationId: deactivateInlineHook + parameters: + - in: path + name: inlineHookId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InlineHook' + description: Success + security: + - api_token: [] + tags: + - InlineHook +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/InlineHook.yaml.sig b/test/registry/src/okta/v1/services/InlineHook.yaml.sig new file mode 100644 index 00000000..1662933a --- /dev/null +++ b/test/registry/src/okta/v1/services/InlineHook.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnB1YY+AKU5Sb0eEXQbuNZS7NyG2sudBaYYi8/iD3dF/iYAMMpgRCdfvGb6hR6p14C25smPmwvXdah/vF232CooY7bAuB4CA== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/LinkedObject.yaml b/test/registry/src/okta/v1/services/LinkedObject.yaml new file mode 100644 index 00000000..9925b4b8 --- /dev/null +++ b/test/registry/src/okta/v1/services/LinkedObject.yaml @@ -0,0 +1,193 @@ +components: + schemas: + LinkedObject: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + associated: + $ref: '#/components/schemas/LinkedObjectDetails' + primary: + $ref: '#/components/schemas/LinkedObjectDetails' + type: object + x-okta-crud: + - alias: create + arguments: + - dest: linkedObjectDefinition + self: true + operationId: addLinkedObjectDefinition + - alias: read + arguments: [] + operationId: getLinkedObjectDefinition + - alias: delete + arguments: + - dest: linkedObjectName + self: true + operationId: deleteLinkedObjectDefinition + x-okta-tags: + - LinkedObject + LinkedObjectDetails: + properties: + description: + type: string + name: + type: string + title: + type: string + type: + $ref: '#/components/schemas/LinkedObjectDetailsType' + type: object + x-okta-tags: + - LinkedObject + LinkedObjectDetailsType: + enum: + - USER + type: string + x-okta-tags: + - LinkedObject + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + idps: + id: okta.linkedobject.idps + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/meta/schemas/user/linkedObjects + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '201' + list: + operation: + $ref: GET + path: + $ref: /api/v1/meta/schemas/user/linkedObjects + response: + mediaType: application/json + openAPIDocKey: '200' + name: idps + title: idps +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/meta/schemas/user/linkedObjects: + get: + description: Success + operationId: listLinkedObjectDefinitions + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/LinkedObject' + type: array + description: Success + security: + - api_token: [] + tags: + - LinkedObject + post: + description: Success + operationId: addLinkedObjectDefinition + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LinkedObject' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/LinkedObject' + description: Created + security: + - api_token: [] + tags: + - LinkedObject + x-codegen-request-body-name: linkedObject + /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}: + delete: + description: Success + operationId: deleteLinkedObjectDefinition + parameters: + - in: path + name: linkedObjectName + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - LinkedObject + get: + description: Success + operationId: getLinkedObjectDefinition + parameters: + - in: path + name: linkedObjectName + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LinkedObject' + description: Success + security: + - api_token: [] + tags: + - LinkedObject +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/LinkedObject.yaml.sig b/test/registry/src/okta/v1/services/LinkedObject.yaml.sig new file mode 100644 index 00000000..1c836396 --- /dev/null +++ b/test/registry/src/okta/v1/services/LinkedObject.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnOQNaKAKU0M5rxV7THu+KNx/j5qiPZ9ghGzm+dTCAajeyzJZ8CBehTlZRHA41LXE7GYAlzwqElQAzdcGMKFEsvmAM7gmMDA== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Log.yaml b/test/registry/src/okta/v1/services/Log.yaml new file mode 100644 index 00000000..67d615fb --- /dev/null +++ b/test/registry/src/okta/v1/services/Log.yaml @@ -0,0 +1,420 @@ +components: + schemas: + LogActor: + properties: + alternateId: + readOnly: true + type: string + detail: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + displayName: + readOnly: true + type: string + id: + readOnly: true + type: string + type: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogAuthenticationContext: + properties: + authenticationProvider: + $ref: '#/components/schemas/LogAuthenticationProvider' + authenticationStep: + readOnly: true + type: integer + credentialProvider: + $ref: '#/components/schemas/LogCredentialProvider' + credentialType: + $ref: '#/components/schemas/LogCredentialType' + externalSessionId: + readOnly: true + type: string + interface: + readOnly: true + type: string + issuer: + $ref: '#/components/schemas/LogIssuer' + type: object + x-okta-tags: + - Log + LogAuthenticationProvider: + enum: + - OKTA_AUTHENTICATION_PROVIDER + - ACTIVE_DIRECTORY + - LDAP + - FEDERATION + - SOCIAL + - FACTOR_PROVIDER + type: string + x-okta-tags: + - Log + LogClient: + properties: + device: + readOnly: true + type: string + geographicalContext: + $ref: '#/components/schemas/LogGeographicalContext' + id: + readOnly: true + type: string + ipAddress: + readOnly: true + type: string + userAgent: + $ref: '#/components/schemas/LogUserAgent' + zone: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogCredentialProvider: + enum: + - OKTA_AUTHENTICATION_PROVIDER + - OKTA_CREDENTIAL_PROVIDER + - RSA + - SYMANTEC + - GOOGLE + - DUO + - YUBIKEY + type: string + x-okta-tags: + - Log + LogCredentialType: + enum: + - OTP + - SMS + - PASSWORD + - ASSERTION + - IWA + - EMAIL + - OAUTH2 + - JWT + type: string + x-okta-tags: + - Log + LogDebugContext: + properties: + debugData: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + type: object + x-okta-tags: + - Log + LogEvent: + properties: + actor: + $ref: '#/components/schemas/LogActor' + authenticationContext: + $ref: '#/components/schemas/LogAuthenticationContext' + client: + $ref: '#/components/schemas/LogClient' + debugContext: + $ref: '#/components/schemas/LogDebugContext' + displayMessage: + readOnly: true + type: string + eventType: + readOnly: true + type: string + legacyEventType: + readOnly: true + type: string + outcome: + $ref: '#/components/schemas/LogOutcome' + published: + format: date-time + readOnly: true + type: string + request: + $ref: '#/components/schemas/LogRequest' + securityContext: + $ref: '#/components/schemas/LogSecurityContext' + severity: + $ref: '#/components/schemas/LogSeverity' + target: + items: + $ref: '#/components/schemas/LogTarget' + readOnly: true + type: array + transaction: + $ref: '#/components/schemas/LogTransaction' + uuid: + readOnly: true + type: string + version: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogGeographicalContext: + properties: + city: + readOnly: true + type: string + country: + readOnly: true + type: string + geolocation: + $ref: '#/components/schemas/LogGeolocation' + postalCode: + readOnly: true + type: string + state: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogGeolocation: + properties: + lat: + format: double + readOnly: true + type: number + lon: + format: double + readOnly: true + type: number + type: object + x-okta-tags: + - Log + LogIpAddress: + properties: + geographicalContext: + $ref: '#/components/schemas/LogGeographicalContext' + ip: + readOnly: true + type: string + source: + readOnly: true + type: string + version: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogIssuer: + properties: + id: + readOnly: true + type: string + type: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogOutcome: + properties: + reason: + readOnly: true + type: string + result: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogRequest: + properties: + ipChain: + items: + $ref: '#/components/schemas/LogIpAddress' + readOnly: true + type: array + type: object + x-okta-tags: + - Log + LogSecurityContext: + properties: + asNumber: + readOnly: true + type: integer + asOrg: + readOnly: true + type: string + domain: + readOnly: true + type: string + isProxy: + readOnly: true + type: boolean + isp: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogSeverity: + enum: + - DEBUG + - INFO + - WARN + - ERROR + type: string + x-okta-tags: + - Log + LogTarget: + properties: + alternateId: + readOnly: true + type: string + detailEntry: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + displayName: + readOnly: true + type: string + id: + readOnly: true + type: string + type: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogTransaction: + properties: + detail: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + id: + readOnly: true + type: string + type: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + LogUserAgent: + properties: + browser: + readOnly: true + type: string + os: + readOnly: true + type: string + rawUserAgent: + readOnly: true + type: string + type: object + x-okta-tags: + - Log + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + logs: + id: okta.log.logs + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/logs + response: + mediaType: application/json + openAPIDocKey: '200' + name: logs + title: logs +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/logs: + get: + description: "The Okta System Log API provides read access to your organization\xE2\ + \u20AC\u2122s system log. This API provides more functionality than the Events\ + \ API" + operationId: getLogs + parameters: + - in: query + name: since + schema: + format: date-time + type: string + - in: query + name: until + schema: + format: date-time + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: limit + schema: + default: 100 + type: integer + - in: query + name: sortOrder + schema: + default: ASCENDING + type: string + - in: query + name: after + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/LogEvent' + type: array + description: Success + security: + - api_token: [] + summary: Fetch a list of events from your Okta organization system log. + tags: + - Log +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Log.yaml.sig b/test/registry/src/okta/v1/services/Log.yaml.sig new file mode 100644 index 00000000..48b38a20 --- /dev/null +++ b/test/registry/src/okta/v1/services/Log.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnFnmdyAKUrhKPdVySzYMdBFw60PXWhaj70C3NwfBUfghoScpGmJ7j92KZkRvEzeVJHNN1FJxfAszNcAdHc83hJXMjCAH+Bw== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/NetworkZone.yaml b/test/registry/src/okta/v1/services/NetworkZone.yaml new file mode 100644 index 00000000..2024f56c --- /dev/null +++ b/test/registry/src/okta/v1/services/NetworkZone.yaml @@ -0,0 +1,393 @@ +components: + schemas: + NetworkZone: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + asns: + items: + type: string + type: array + created: + format: date-time + readOnly: true + type: string + gateways: + items: + $ref: '#/components/schemas/NetworkZoneAddress' + type: array + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + locations: + items: + $ref: '#/components/schemas/NetworkZoneLocation' + type: array + name: + type: string + proxies: + items: + $ref: '#/components/schemas/NetworkZoneAddress' + type: array + proxyType: + type: string + status: + $ref: '#/components/schemas/NetworkZoneStatus' + system: + type: boolean + type: + $ref: '#/components/schemas/NetworkZoneType' + usage: + $ref: '#/components/schemas/NetworkZoneUsage' + type: object + x-okta-crud: + - alias: read + arguments: + - dest: zoneId + src: id + operationId: getNetworkZone + - alias: update + arguments: + - dest: zoneId + src: id + - dest: zone + self: true + operationId: updateNetworkZone + - alias: delete + arguments: + - dest: zoneId + src: id + operationId: deleteNetworkZone + x-okta-operations: + - alias: activate + arguments: + - dest: zoneId + src: id + operationId: activateNetworkZone + - alias: deactivate + arguments: + - dest: zoneId + src: id + operationId: deactivateNetworkZone + x-okta-tags: + - NetworkZone + NetworkZoneAddress: + properties: + type: + $ref: '#/components/schemas/NetworkZoneAddressType' + value: + type: string + type: object + x-okta-tags: + - NetworkZone + NetworkZoneAddressType: + enum: + - CIDR + - RANGE + type: string + x-okta-tags: + - NetworkZone + NetworkZoneLocation: + properties: + country: + type: string + region: + type: string + type: object + x-okta-tags: + - NetworkZone + NetworkZoneStatus: + enum: + - ACTIVE + - INACTIVE + type: string + x-okta-tags: + - NetworkZone + NetworkZoneType: + enum: + - IP + - DYNAMIC + type: string + x-okta-tags: + - NetworkZone + NetworkZoneUsage: + enum: + - POLICY + - BLOCKLIST + type: string + x-okta-tags: + - NetworkZone + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + zones: + id: okta.networkzone.zones + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/zones/{zoneId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/zones/{zoneId}/lifecycle/deactivate + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/zones/{zoneId} + response: + openAPIDocKey: '200' + get: + operation: + $ref: GET + path: + $ref: /api/v1/zones/{zoneId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/zones + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/zones + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/zones/{zoneId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: zones + title: zones +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/zones: + get: + description: Enumerates network zones added to your organization with pagination. + A subset of zones can be returned that match a supported filter expression + or query. + operationId: listNetworkZones + parameters: + - description: Specifies the pagination cursor for the next page of network + zones + in: query + name: after + schema: + type: string + - description: Specifies the number of results for a page + in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + - description: Filters zones by usage or id expression + in: query + name: filter + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/NetworkZone' + type: array + description: Success + security: + - api_token: [] + summary: List Network Zones + tags: + - NetworkZone + post: + description: Adds a new network zone to your Okta organization. + operationId: createNetworkZone + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkZone' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkZone' + description: Success + security: + - api_token: [] + summary: Add Network Zone + tags: + - NetworkZone + x-codegen-request-body-name: zone + /api/v1/zones/{zoneId}: + delete: + description: Removes network zone. + operationId: deleteNetworkZone + parameters: + - in: path + name: zoneId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + summary: Delete Network Zone + tags: + - NetworkZone + get: + description: Fetches a network zone from your Okta organization by `id`. + operationId: getNetworkZone + parameters: + - in: path + name: zoneId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkZone' + description: Success + security: + - api_token: [] + summary: Get Network Zone + tags: + - NetworkZone + put: + description: Updates a network zone in your organization. + operationId: updateNetworkZone + parameters: + - in: path + name: zoneId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkZone' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkZone' + description: Success + security: + - api_token: [] + summary: Update Network Zone + tags: + - NetworkZone + x-codegen-request-body-name: zone + /api/v1/zones/{zoneId}/lifecycle/activate: + post: + description: Activate Network Zone + operationId: activateNetworkZone + parameters: + - in: path + name: zoneId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkZone' + description: Success + security: + - api_token: [] + summary: Activate Network Zone + tags: + - NetworkZone + /api/v1/zones/{zoneId}/lifecycle/deactivate: + post: + description: Deactivates a network zone. + operationId: deactivateNetworkZone + parameters: + - in: path + name: zoneId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkZone' + description: Success + security: + - api_token: [] + summary: Deactivate Network Zone + tags: + - NetworkZone +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/NetworkZone.yaml.sig b/test/registry/src/okta/v1/services/NetworkZone.yaml.sig new file mode 100644 index 00000000..0d9b1b38 --- /dev/null +++ b/test/registry/src/okta/v1/services/NetworkZone.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmN2VxOAKUTVsMLRy1IzJiywWO52Nz9ZLxLEEjF6/A6UMwq98jWBDit3SQ71KbymzGf9SLMl8QPnzGQS8uPLk4sZ4orNIRDw== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Org.yaml b/test/registry/src/okta/v1/services/Org.yaml new file mode 100644 index 00000000..d1b4614a --- /dev/null +++ b/test/registry/src/okta/v1/services/Org.yaml @@ -0,0 +1,711 @@ +components: + schemas: + OrgContactType: + enum: + - BILLING + - TECHNICAL + type: string + x-okta-tags: + - Org + OrgContactTypeObj: + properties: + _links: + type: object + contactType: + $ref: '#/components/schemas/OrgContactType' + type: object + x-okta-tags: + - Org + OrgContactUser: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + userId: + type: string + type: object + x-okta-operations: + - alias: updateContactUser + arguments: + - dest: userId + src: userId + operationId: updateOrgContactUser + x-okta-tags: + - Org + OrgOktaCommunicationSetting: + properties: + _links: + type: object + optOutEmailUsers: + readOnly: true + type: boolean + type: object + x-okta-operations: + - alias: optInUsersToOktaCommunicationEmails + operationId: optInUsersToOktaCommunicationEmails + - alias: optOutUsersFromOktaCommunicationEmails + operationId: optOutUsersFromOktaCommunicationEmails + x-okta-tags: + - Org + OrgOktaSupportSetting: + enum: + - DISABLED + - ENABLED + type: string + x-okta-tags: + - Org + OrgOktaSupportSettingsObj: + properties: + _links: + type: object + expiration: + format: date-time + readOnly: true + type: string + support: + $ref: '#/components/schemas/OrgOktaSupportSetting' + type: object + x-okta-operations: + - alias: extendOktaSupport + operationId: extendOktaSupport + - alias: grantOktaSupport + operationId: grantOktaSupport + - alias: revokeOktaSupport + operationId: revokeOktaSupport + x-okta-tags: + - Org + OrgPreferences: + properties: + _links: + type: object + showEndUserFooter: + readOnly: true + type: boolean + type: object + x-okta-operations: + - alias: hideEndUserFooter + operationId: hideOktaUIFooter + - alias: showEndUserFooter + operationId: showOktaUIFooter + x-okta-tags: + - Org + OrgSetting: + properties: + _links: + type: object + address1: + type: string + address2: + type: string + city: + type: string + companyName: + type: string + country: + type: string + created: + format: date-time + readOnly: true + type: string + endUserSupportHelpURL: + type: string + expiresAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + phoneNumber: + type: string + postalCode: + type: string + state: + type: string + status: + readOnly: true + type: string + subdomain: + readOnly: true + type: string + supportPhoneNumber: + type: string + website: + type: string + type: object + x-okta-crud: + - alias: read + arguments: + - dest: orgSetting + self: true + operationId: getOrgSettings + - alias: update + arguments: + - dest: orgSetting + self: true + operationId: updateOrgSetting + - alias: partialUpdate + arguments: + - dest: orgSetting + self: true + operationId: partialUpdateOrgSetting + - alias: contactTypes + arguments: + - dest: orgSetting + self: true + operationId: getOrgContactTypes + - alias: contactUser + arguments: + - dest: orgSetting + self: true + operationId: getOrgContactUser + - alias: updateContactUser + arguments: + - dest: orgSetting + self: true + operationId: updateOrgContactUser + - alias: supportSettings + arguments: + - dest: orgSetting + self: true + operationId: getOrgOktaSupportSettings + - alias: grantSupport + arguments: + - dest: orgSetting + self: true + operationId: grantOktaSupport + - alias: extendSupport + arguments: + - dest: orgSetting + self: true + operationId: extendOktaSupport + - alias: revokeSupport + arguments: + - dest: orgSetting + self: true + operationId: revokeOktaSupport + - alias: communicationSettings + arguments: + - dest: orgSetting + self: true + operationId: getOktaCommunicationSettings + - alias: optOutCommunications + arguments: + - dest: orgSetting + self: true + operationId: optOutUsersFromOktaCommunicationEmails + - alias: optInCommunications + arguments: + - dest: orgSetting + self: true + operationId: optInUsersToOktaCommunicationEmails + - alias: orgPreferences + arguments: + - dest: orgSetting + self: true + operationId: getOrgPreferences + - alias: showFooter + arguments: + - dest: orgSetting + self: true + operationId: showOktaUIFooter + - alias: hideFooter + arguments: + - dest: orgSetting + self: true + operationId: hideOktaUIFooter + x-okta-tags: + - Org + UserIdString: + properties: + userId: + type: string + type: object + x-okta-tags: + - Org + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + contacts: + id: okta.org.contacts + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/org/contacts/{contactType} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/org/contacts + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/org/contacts/{contactType} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: contacts + title: contacts + oktacommunication: + id: okta.org.oktacommunication + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/org/privacy/oktaCommunication + response: + mediaType: application/json + openAPIDocKey: '200' + optIn: + operation: + $ref: POST + path: + $ref: /api/v1/org/privacy/oktaCommunication/optIn + response: + mediaType: application/json + openAPIDocKey: '200' + optOut: + operation: + $ref: POST + path: + $ref: /api/v1/org/privacy/oktaCommunication/optOut + response: + mediaType: application/json + openAPIDocKey: '200' + name: oktacommunication + title: oktacommunication + oktasupport: + id: okta.org.oktasupport + methods: + extend: + operation: + $ref: POST + path: + $ref: /api/v1/org/privacy/oktaSupport/extend + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: GET + path: + $ref: /api/v1/org/privacy/oktaSupport + response: + mediaType: application/json + openAPIDocKey: '200' + grant: + operation: + $ref: POST + path: + $ref: /api/v1/org/privacy/oktaSupport/grant + response: + mediaType: application/json + openAPIDocKey: '200' + revoke: + operation: + $ref: POST + path: + $ref: /api/v1/org/privacy/oktaSupport/revoke + response: + mediaType: application/json + openAPIDocKey: '200' + name: oktasupport + title: oktasupport + org: + id: okta.org.org + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/org + response: + mediaType: application/json + openAPIDocKey: '200' + partialUpdate: + operation: + $ref: POST + path: + $ref: /api/v1/org + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/org + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: org + title: org + preferences: + id: okta.org.preferences + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/org/preferences + response: + mediaType: application/json + openAPIDocKey: '200' + hideEndUserFooter: + operation: + $ref: POST + path: + $ref: /api/v1/org/preferences/hideEndUserFooter + response: + mediaType: application/json + openAPIDocKey: '200' + showEndUserFooter: + operation: + $ref: POST + path: + $ref: /api/v1/org/preferences/showEndUserFooter + response: + mediaType: application/json + openAPIDocKey: '200' + name: preferences + title: preferences +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/org: + get: + description: Get settings of your organization. + operationId: getOrgSettings + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgSetting' + description: Success + security: + - api_token: [] + summary: Get org settings + tags: + - Org + post: + description: Partial update settings of your organization. + operationId: partialUpdateOrgSetting + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrgSetting' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgSetting' + description: Success + security: + - api_token: [] + summary: Partial update Org setting + tags: + - Org + x-codegen-request-body-name: orgSetting + put: + description: Update settings of your organization. + operationId: updateOrgSetting + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrgSetting' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgSetting' + description: Success + security: + - api_token: [] + summary: Update Org setting + tags: + - Org + x-codegen-request-body-name: orgSetting + /api/v1/org/contacts: + get: + description: Gets Contact Types of your organization. + operationId: getOrgContactTypes + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OrgContactTypeObj' + type: array + description: Success + security: + - api_token: [] + summary: Get org contact types + tags: + - Org + /api/v1/org/contacts/{contactType}: + get: + description: Retrieves the URL of the User associated with the specified Contact + Type. + operationId: getOrgContactUser + parameters: + - in: path + name: contactType + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgContactUser' + description: Success + security: + - api_token: [] + summary: Get org contact user + tags: + - Org + put: + description: Updates the User associated with the specified Contact Type. + operationId: updateOrgContactUser + parameters: + - in: path + name: contactType + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdString' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgContactUser' + description: Success + security: + - api_token: [] + summary: Update org contact user + tags: + - Org + x-codegen-request-body-name: userId + /api/v1/org/preferences: + get: + description: Gets preferences of your organization. + operationId: getOrgPreferences + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgPreferences' + description: Success + security: + - api_token: [] + summary: Get org preferences + tags: + - Org + /api/v1/org/preferences/hideEndUserFooter: + post: + description: Hide the Okta UI footer for all end users of your organization. + operationId: hideOktaUIFooter + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgPreferences' + description: Success + security: + - api_token: [] + summary: Show Okta UI Footer + tags: + - Org + /api/v1/org/preferences/showEndUserFooter: + post: + description: Makes the Okta UI footer visible for all end users of your organization. + operationId: showOktaUIFooter + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgPreferences' + description: Success + security: + - api_token: [] + summary: Show Okta UI Footer + tags: + - Org + /api/v1/org/privacy/oktaCommunication: + get: + description: Gets Okta Communication Settings of your organization. + operationId: getOktaCommunicationSettings + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgOktaCommunicationSetting' + description: Success + security: + - api_token: [] + summary: Get Okta Communication Settings + tags: + - Org + /api/v1/org/privacy/oktaCommunication/optIn: + post: + description: Opts in all users of this org to Okta Communication emails. + operationId: optInUsersToOktaCommunicationEmails + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgOktaCommunicationSetting' + description: Success + security: + - api_token: [] + summary: Opt in all users to Okta Communication emails + tags: + - Org + /api/v1/org/privacy/oktaCommunication/optOut: + post: + description: Opts out all users of this org from Okta Communication emails. + operationId: optOutUsersFromOktaCommunicationEmails + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgOktaCommunicationSetting' + description: Success + security: + - api_token: [] + summary: Opt out all users from Okta Communication emails + tags: + - Org + /api/v1/org/privacy/oktaSupport: + get: + description: Gets Okta Support Settings of your organization. + operationId: getOrgOktaSupportSettings + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgOktaSupportSettingsObj' + description: Success + security: + - api_token: [] + summary: Get Okta Support settings + tags: + - Org + /api/v1/org/privacy/oktaSupport/extend: + post: + description: Extends the length of time that Okta Support can access your org + by 24 hours. This means that 24 hours are added to the remaining access time. + operationId: extendOktaSupport + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgOktaSupportSettingsObj' + description: Success + security: + - api_token: [] + summary: Extend Okta Support + tags: + - Org + /api/v1/org/privacy/oktaSupport/grant: + post: + description: Enables you to temporarily allow Okta Support to access your org + as an administrator for eight hours. + operationId: grantOktaSupport + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgOktaSupportSettingsObj' + description: Success + security: + - api_token: [] + summary: Grant Okta Support + tags: + - Org + /api/v1/org/privacy/oktaSupport/revoke: + post: + description: Revokes Okta Support access to your organization. + operationId: revokeOktaSupport + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgOktaSupportSettingsObj' + description: Success + security: + - api_token: [] + summary: Extend Okta Support + tags: + - Org +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Org.yaml.sig b/test/registry/src/okta/v1/services/Org.yaml.sig new file mode 100644 index 00000000..f7d29874 --- /dev/null +++ b/test/registry/src/okta/v1/services/Org.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnOvzYaAKUbHO3pQsleBqJ55u1QwyZLqwiuJMgbuc22zS9IWAKwa79QmhWbSxSb9NBX5x7d+6LZjwL6FyXPlxuOGnAFKreBg== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Policy.yaml b/test/registry/src/okta/v1/services/Policy.yaml new file mode 100644 index 00000000..2d2b1322 --- /dev/null +++ b/test/registry/src/okta/v1/services/Policy.yaml @@ -0,0 +1,1681 @@ +components: + schemas: + AppAndInstanceConditionEvaluatorAppOrInstance: + properties: + id: + readOnly: true + type: string + name: + type: string + type: + enum: + - APP_TYPE + - APP + type: string + type: object + x-okta-tags: + - Policy + AppAndInstancePolicyRuleCondition: + properties: + exclude: + items: + $ref: '#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance' + type: array + include: + items: + $ref: '#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance' + type: array + type: object + x-okta-tags: + - Policy + AppInstancePolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + BeforeScheduledActionPolicyRuleCondition: + properties: + duration: + $ref: '#/components/schemas/Duration' + lifecycleAction: + $ref: '#/components/schemas/ScheduledUserLifecycleAction' + type: object + x-okta-tags: + - Policy + ClientPolicyCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + ContextPolicyRuleCondition: + properties: + expression: + type: string + type: object + x-okta-tags: + - Policy + DevicePolicyRuleCondition: + properties: + migrated: + type: boolean + platform: + $ref: '#/components/schemas/DevicePolicyRuleConditionPlatform' + rooted: + type: boolean + trustLevel: + enum: + - ANY + - TRUSTED + type: string + type: object + x-okta-tags: + - Policy + DevicePolicyRuleConditionPlatform: + properties: + supportedMDMFrameworks: + items: + enum: + - AFW + - SAFE + - NATIVE + type: string + type: array + types: + items: + enum: + - IOS + - ANDROID + - OSX + - WINDOWS + type: string + type: array + type: object + x-okta-tags: + - Policy + Duration: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + GrantTypePolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + GroupCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + GroupPolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + IdentityProviderPolicy: + properties: + accountLink: + $ref: '#/components/schemas/PolicyAccountLink' + maxClockSkew: + type: integer + provisioning: + $ref: '#/components/schemas/Provisioning' + subject: + $ref: '#/components/schemas/PolicySubject' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + IdentityProviderPolicyRuleCondition: + properties: + idpIds: + items: + type: string + type: array + provider: + enum: + - ANY + - OKTA + - SPECIFIC_IDP + type: string + type: object + x-okta-tags: + - Policy + InactivityPolicyRuleCondition: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + LifecycleExpirationPolicyRuleCondition: + properties: + lifecycleStatus: + type: string + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + MDMEnrollmentPolicyRuleCondition: + properties: + blockNonSafeAndroid: + type: boolean + enrollment: + enum: + - OMM + - ANY_OR_NONE + type: string + type: object + x-okta-tags: + - Policy + OAuth2ScopesMediationPolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + OAuthAuthorizationPolicy: + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + OktaSignOnPolicy: + properties: + conditions: + $ref: '#/components/schemas/OktaSignOnPolicyConditions' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + OktaSignOnPolicyConditions: + properties: + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleConditions' + x-okta-tags: + - Policy + OktaSignOnPolicyRule: + properties: + actions: + $ref: '#/components/schemas/OktaSignOnPolicyRuleActions' + conditions: + $ref: '#/components/schemas/OktaSignOnPolicyRuleConditions' + name: + type: string + type: object + x-okta-parent: '#/components/schemas/PolicyRule' + x-okta-tags: + - Policy + OktaSignOnPolicyRuleActions: + properties: + signon: + $ref: '#/components/schemas/OktaSignOnPolicyRuleSignonActions' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleActions' + x-okta-tags: + - Policy + OktaSignOnPolicyRuleConditions: + properties: + authContext: + $ref: '#/components/schemas/PolicyRuleAuthContextCondition' + network: + $ref: '#/components/schemas/PolicyNetworkCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleConditions' + x-okta-tags: + - Policy + OktaSignOnPolicyRuleSignonActions: + properties: + access: + enum: + - ALLOW + - DENY + type: string + factorLifetime: + type: integer + factorPromptMode: + enum: + - ALWAYS + - DEVICE + - SESSION + type: string + rememberDeviceByDefault: + default: false + type: boolean + requireFactor: + default: false + type: boolean + session: + $ref: '#/components/schemas/OktaSignOnPolicyRuleSignonSessionActions' + type: object + x-okta-tags: + - Policy + OktaSignOnPolicyRuleSignonSessionActions: + properties: + maxSessionIdleMinutes: + type: integer + maxSessionLifetimeMinutes: + type: integer + usePersistentCookie: + default: false + type: boolean + type: object + x-okta-tags: + - Policy + PasswordDictionary: + properties: + common: + $ref: '#/components/schemas/PasswordDictionaryCommon' + type: object + x-okta-tags: + - Policy + PasswordDictionaryCommon: + properties: + exclude: + default: false + type: boolean + type: object + x-okta-tags: + - Policy + PasswordExpirationPolicyRuleCondition: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicy: + properties: + conditions: + $ref: '#/components/schemas/PasswordPolicyConditions' + settings: + $ref: '#/components/schemas/PasswordPolicySettings' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + PasswordPolicyAuthenticationProviderCondition: + properties: + include: + items: + type: string + type: array + provider: + enum: + - ACTIVE_DIRECTORY + - ANY + - LDAP + - OKTA + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyConditions: + properties: + authProvider: + $ref: '#/components/schemas/PasswordPolicyAuthenticationProviderCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleConditions' + x-okta-tags: + - Policy + PasswordPolicyDelegationSettings: + properties: + options: + $ref: '#/components/schemas/PasswordPolicyDelegationSettingsOptions' + type: object + x-okta-tags: + - Policy + PasswordPolicyDelegationSettingsOptions: + properties: + skipUnlock: + type: boolean + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettings: + properties: + age: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsAge' + complexity: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsComplexity' + lockout: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsLockout' + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsAge: + properties: + expireWarnDays: + type: integer + historyCount: + type: integer + maxAgeDays: + type: integer + minAgeMinutes: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsComplexity: + properties: + dictionary: + $ref: '#/components/schemas/PasswordDictionary' + excludeAttributes: + items: + type: string + type: array + excludeUsername: + default: true + type: boolean + minLength: + type: integer + minLowerCase: + type: integer + minNumber: + type: integer + minSymbol: + type: integer + minUpperCase: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsLockout: + properties: + autoUnlockMinutes: + type: integer + maxAttempts: + type: integer + showLockoutFailures: + type: boolean + userLockoutNotificationChannels: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmail: + properties: + properties: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmailProperties' + status: + enum: + - ACTIVE + - INACTIVE + readOnly: true + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmailProperties: + properties: + recoveryToken: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmailRecoveryToken' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmailRecoveryToken: + properties: + tokenLifetimeMinutes: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryFactorSettings: + properties: + status: + default: INACTIVE + enum: + - ACTIVE + - INACTIVE + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryFactors: + properties: + okta_call: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactorSettings' + okta_email: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmail' + okta_sms: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactorSettings' + recovery_question: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestion' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestion: + properties: + properties: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestionProperties' + status: + enum: + - ACTIVE + - INACTIVE + readOnly: true + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestionComplexity: + properties: + minLength: + readOnly: true + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestionProperties: + properties: + complexity: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestionComplexity' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoverySettings: + properties: + factors: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactors' + type: object + x-okta-tags: + - Policy + PasswordPolicyRule: + properties: + actions: + $ref: '#/components/schemas/PasswordPolicyRuleActions' + conditions: + $ref: '#/components/schemas/PasswordPolicyRuleConditions' + name: + type: string + type: object + x-okta-parent: '#/components/schemas/PolicyRule' + x-okta-tags: + - Policy + PasswordPolicyRuleAction: + properties: + access: + enum: + - ALLOW + - DENY + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRuleActions: + properties: + passwordChange: + $ref: '#/components/schemas/PasswordPolicyRuleAction' + selfServicePasswordReset: + $ref: '#/components/schemas/PasswordPolicyRuleAction' + selfServiceUnlock: + $ref: '#/components/schemas/PasswordPolicyRuleAction' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleActions' + x-okta-tags: + - Policy + PasswordPolicyRuleConditions: + properties: + network: + $ref: '#/components/schemas/PolicyNetworkCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleConditions' + x-okta-tags: + - Policy + PasswordPolicySettings: + properties: + delegation: + $ref: '#/components/schemas/PasswordPolicyDelegationSettings' + password: + $ref: '#/components/schemas/PasswordPolicyPasswordSettings' + recovery: + $ref: '#/components/schemas/PasswordPolicyRecoverySettings' + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatform: + properties: + os: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystem' + type: + enum: + - DESKTOP + - MOBILE + - OTHER + - ANY + type: string + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatformOperatingSystem: + properties: + expression: + type: string + type: + enum: + - ANDROID + - IOS + - WINDOWS + - OSX + - OTHER + - ANY + type: string + version: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion' + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatformOperatingSystemVersion: + properties: + matchType: + enum: + - EXPRESSION + - SEMVER + type: string + value: + type: string + type: object + x-okta-tags: + - Policy + PlatformPolicyRuleCondition: + properties: + exclude: + items: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatform' + type: array + include: + items: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatform' + type: array + type: object + x-okta-tags: + - Policy + Policy: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + conditions: + $ref: '#/components/schemas/PolicyRuleConditions' + created: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + priority: + type: integer + status: + enum: + - ACTIVE + - INACTIVE + type: string + system: + type: boolean + type: + $ref: '#/components/schemas/PolicyType' + type: object + x-okta-crud: + - alias: read + arguments: + - dest: policyId + src: id + operationId: getPolicy + - alias: update + arguments: + - dest: policyId + src: id + - dest: policy + self: true + operationId: updatePolicy + - alias: delete + arguments: + - dest: policyId + src: id + operationId: deletePolicy + x-okta-operations: + - alias: activate + arguments: + - dest: policyId + src: id + operationId: activatePolicy + - alias: deactivate + arguments: + - dest: policyId + src: id + operationId: deactivatePolicy + - alias: listPolicyRules + arguments: + - dest: policyId + src: id + operationId: listPolicyRules + - alias: createRule + arguments: + - dest: policyId + src: id + operationId: createPolicyRule + - alias: getPolicyRule + arguments: + - dest: policyId + src: id + operationId: getPolicyRule + x-okta-tags: + - Policy + x-openapi-v3-discriminator: + mapping: + IDP_DISCOVERY: '#/components/schemas/IdentityProviderPolicy' + OAUTH_AUTHORIZATION_POLICY: '#/components/schemas/OAuthAuthorizationPolicy' + OKTA_SIGN_ON: '#/components/schemas/OktaSignOnPolicy' + PASSWORD: '#/components/schemas/PasswordPolicy' + propertyName: type + PolicyAccountLink: + properties: + action: + enum: + - AUTO + - DISABLED + type: string + filter: + $ref: '#/components/schemas/PolicyAccountLinkFilter' + type: object + x-okta-tags: + - Policy + PolicyAccountLinkFilter: + properties: + groups: + $ref: '#/components/schemas/PolicyAccountLinkFilterGroups' + type: object + x-okta-tags: + - Policy + PolicyAccountLinkFilterGroups: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PolicyNetworkCondition: + properties: + connection: + enum: + - ANYWHERE + - ZONE + type: string + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PolicyPeopleCondition: + properties: + groups: + $ref: '#/components/schemas/GroupCondition' + users: + $ref: '#/components/schemas/UserCondition' + type: object + x-okta-tags: + - Policy + PolicyRule: + properties: + actions: + $ref: '#/components/schemas/PolicyRuleActions' + conditions: + $ref: '#/components/schemas/PolicyRuleConditions' + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + priority: + type: integer + status: + default: ACTIVE + enum: + - ACTIVE + - INACTIVE + type: string + system: + default: false + type: boolean + type: + enum: + - SIGN_ON + - PASSWORD + type: string + type: object + x-okta-crud: + - alias: update + arguments: + - dest: ruleId + src: id + - dest: policyRule + self: true + - dest: policyId + parentSrc: id + operationId: updatePolicyRule + - alias: delete + arguments: + - dest: ruleId + src: id + - dest: policyId + parentSrc: policyId + operationId: deletePolicyRule + x-okta-operations: + - alias: activate + arguments: + - dest: ruleId + src: id + - dest: policyId + parentSrc: policyId + operationId: activatePolicyRule + - alias: deactivate + arguments: + - dest: ruleId + src: id + - dest: policyId + parentSrc: policyId + operationId: deactivatePolicyRule + x-okta-tags: + - Policy + x-openapi-v3-discriminator: + mapping: + PASSWORD: '#/components/schemas/PasswordPolicyRule' + SIGN_ON: '#/components/schemas/OktaSignOnPolicyRule' + propertyName: type + PolicyRuleActions: + properties: + enroll: + $ref: '#/components/schemas/PolicyRuleActionsEnroll' + passwordChange: + $ref: '#/components/schemas/PasswordPolicyRuleAction' + selfServicePasswordReset: + $ref: '#/components/schemas/PasswordPolicyRuleAction' + selfServiceUnlock: + $ref: '#/components/schemas/PasswordPolicyRuleAction' + signon: + $ref: '#/components/schemas/OktaSignOnPolicyRuleSignonActions' + type: object + x-okta-tags: + - Policy + PolicyRuleActionsEnroll: + properties: + self: + $ref: '#/components/schemas/PolicyRuleActionsEnrollSelf' + type: object + x-okta-tags: + - Policy + PolicyRuleActionsEnrollSelf: + enum: + - CHALLENGE + - LOGIN + - NEVER + type: string + x-okta-tags: + - Policy + PolicyRuleAuthContextCondition: + properties: + authType: + enum: + - ANY + - RADIUS + type: string + type: object + x-okta-tags: + - Policy + PolicyRuleConditions: + properties: + app: + $ref: '#/components/schemas/AppAndInstancePolicyRuleCondition' + apps: + $ref: '#/components/schemas/AppInstancePolicyRuleCondition' + authContext: + $ref: '#/components/schemas/PolicyRuleAuthContextCondition' + authProvider: + $ref: '#/components/schemas/PasswordPolicyAuthenticationProviderCondition' + beforeScheduledAction: + $ref: '#/components/schemas/BeforeScheduledActionPolicyRuleCondition' + clients: + $ref: '#/components/schemas/ClientPolicyCondition' + context: + $ref: '#/components/schemas/ContextPolicyRuleCondition' + device: + $ref: '#/components/schemas/DevicePolicyRuleCondition' + grantTypes: + $ref: '#/components/schemas/GrantTypePolicyRuleCondition' + groups: + $ref: '#/components/schemas/GroupPolicyRuleCondition' + identityProvider: + $ref: '#/components/schemas/IdentityProviderPolicyRuleCondition' + mdmEnrollment: + $ref: '#/components/schemas/MDMEnrollmentPolicyRuleCondition' + network: + $ref: '#/components/schemas/PolicyNetworkCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + platform: + $ref: '#/components/schemas/PlatformPolicyRuleCondition' + risk: + $ref: '#/components/schemas/RiskPolicyRuleCondition' + riskScore: + $ref: '#/components/schemas/RiskScorePolicyRuleCondition' + scopes: + $ref: '#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition' + userIdentifier: + $ref: '#/components/schemas/UserIdentifierPolicyRuleCondition' + userStatus: + $ref: '#/components/schemas/UserStatusPolicyRuleCondition' + users: + $ref: '#/components/schemas/UserPolicyRuleCondition' + type: object + x-okta-tags: + - Policy + PolicySubject: + properties: + filter: + type: string + format: + items: + type: string + type: array + matchAttribute: + type: string + matchType: + $ref: '#/components/schemas/PolicySubjectMatchType' + userNameTemplate: + $ref: '#/components/schemas/PolicyUserNameTemplate' + type: object + x-okta-tags: + - Policy + PolicySubjectMatchType: + enum: + - USERNAME + - EMAIL + - USERNAME_OR_EMAIL + - CUSTOM_ATTRIBUTE + type: string + x-okta-tags: + - Policy + PolicyType: + enum: + - OAUTH_AUTHORIZATION_POLICY + - OKTA_SIGN_ON + - PASSWORD + - IDP_DISCOVERY + type: string + x-okta-tags: + - Policy + PolicyUserNameTemplate: + properties: + template: + type: string + type: object + x-okta-tags: + - Policy + Provisioning: + properties: + action: + enum: + - AUTO + - CALLOUT + - DISABLED + type: string + conditions: + $ref: '#/components/schemas/ProvisioningConditions' + groups: + $ref: '#/components/schemas/ProvisioningGroups' + profileMaster: + type: boolean + type: object + x-okta-tags: + - IdentityProvider + ProvisioningConditions: + properties: + deprovisioned: + $ref: '#/components/schemas/ProvisioningDeprovisionedCondition' + suspended: + $ref: '#/components/schemas/ProvisioningSuspendedCondition' + type: object + x-okta-tags: + - IdentityProvider + ProvisioningDeprovisionedCondition: + properties: + action: + enum: + - NONE + - REACTIVATE + type: string + type: object + x-okta-tags: + - IdentityProvider + ProvisioningGroups: + properties: + action: + enum: + - NONE + - APPEND + - SYNC + - ASSIGN + type: string + assignments: + items: + type: string + type: array + filter: + items: + type: string + type: array + sourceAttributeName: + type: string + type: object + x-okta-tags: + - IdentityProvider + ProvisioningSuspendedCondition: + properties: + action: + enum: + - NONE + - UNSUSPEND + type: string + type: object + x-okta-tags: + - IdentityProvider + RiskPolicyRuleCondition: + properties: + behaviors: + items: + type: string + type: array + uniqueItems: true + type: object + x-okta-tags: + - Policy + RiskScorePolicyRuleCondition: + properties: + level: + type: string + type: object + x-okta-tags: + - Policy + ScheduledUserLifecycleAction: + properties: + status: + enum: + - ACTIVE + - INACTIVE + - PENDING + - DELETED + - EXPIRED_PASSWORD + - ACTIVATING + - SUSPENDED + - DELETING + type: string + type: object + x-okta-tags: + - Policy + UserCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + UserIdentifierConditionEvaluatorPattern: + properties: + matchType: + enum: + - SUFFIX + - EXPRESSION + - STARTS_WITH + - EQUALS + - CONTAINS + type: string + value: + type: string + type: object + x-okta-tags: + - Policy + UserIdentifierPolicyRuleCondition: + properties: + attribute: + type: string + patterns: + items: + $ref: '#/components/schemas/UserIdentifierConditionEvaluatorPattern' + type: array + type: + enum: + - IDENTIFIER + - ATTRIBUTE + type: string + type: object + x-okta-tags: + - Policy + UserIdentityProviderLinkRequest: + properties: + externalId: + type: string + type: object + x-okta-tags: + - Policy + UserLifecycleAttributePolicyRuleCondition: + properties: + attributeName: + type: string + matchingValue: + type: string + type: object + x-okta-tags: + - Policy + UserPolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + inactivity: + $ref: '#/components/schemas/InactivityPolicyRuleCondition' + include: + items: + type: string + type: array + lifecycleExpiration: + $ref: '#/components/schemas/LifecycleExpirationPolicyRuleCondition' + passwordExpiration: + $ref: '#/components/schemas/PasswordExpirationPolicyRuleCondition' + userLifecycleAttribute: + $ref: '#/components/schemas/UserLifecycleAttributePolicyRuleCondition' + type: object + x-okta-tags: + - Policy + UserStatusPolicyRuleCondition: + properties: + value: + enum: + - ACTIVE + - INACTIVE + - PENDING + - DELETED + - EXPIRED_PASSWORD + - ACTIVATING + - SUSPENDED + - DELETING + type: string + type: object + x-okta-tags: + - Policy + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + policies: + id: okta.policy.policies + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate + response: + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate + response: + openAPIDocKey: '204' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/policies/{policyId} + response: + openAPIDocKey: '200' + get: + operation: + $ref: GET + path: + $ref: /api/v1/policies/{policyId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/policies + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/policies + response: + mediaType: application/json + openAPIDocKey: '200' + name: policies + title: policies + rules: + id: okta.policy.rules + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate + response: + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate + response: + openAPIDocKey: '204' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/policies/{policyId}/rules/{ruleId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/policies/{policyId}/rules/{ruleId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/policies/{policyId}/rules + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/policies + response: + mediaType: application/json + openAPIDocKey: '200' + put: + operation: + $ref: PUT + path: + $ref: /api/v1/policies/{policyId}/rules/{ruleId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: rules + title: rules +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/policies: + get: + description: Gets all policies with the specified type. + operationId: listPolicies + parameters: + - in: query + name: type + required: true + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Policy' + type: array + description: Success + security: + - api_token: [] + tags: + - Policy + post: + description: Creates a policy. + operationId: createPolicy + parameters: + - in: query + name: activate + schema: + default: true + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Success + security: + - api_token: [] + tags: + - Policy + x-codegen-request-body-name: policy + /api/v1/policies/{policyId}: + delete: + description: Removes a policy. + operationId: deletePolicy + parameters: + - in: path + name: policyId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - Policy + get: + description: Gets a policy. + operationId: getPolicy + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Success + security: + - api_token: [] + tags: + - Policy + put: + description: Updates a policy. + operationId: updatePolicy + parameters: + - in: path + name: policyId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + description: Success + security: + - api_token: [] + tags: + - Policy + x-codegen-request-body-name: policy + /api/v1/policies/{policyId}/lifecycle/activate: + post: + description: Activates a policy. + operationId: activatePolicy + parameters: + - in: path + name: policyId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Policy + /api/v1/policies/{policyId}/lifecycle/deactivate: + post: + description: Deactivates a policy. + operationId: deactivatePolicy + parameters: + - in: path + name: policyId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Policy + /api/v1/policies/{policyId}/rules: + get: + description: Enumerates all policy rules. + operationId: listPolicyRules + parameters: + - in: path + name: policyId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/PolicyRule' + type: array + description: Success + security: + - api_token: [] + tags: + - Policy + post: + description: Creates a policy rule. + operationId: createPolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRule' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRule' + description: Success + security: + - api_token: [] + tags: + - Policy + x-codegen-request-body-name: policyRule + /api/v1/policies/{policyId}/rules/{ruleId}: + delete: + description: Removes a policy rule. + operationId: deletePolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Policy + get: + description: Gets a policy rule. + operationId: getPolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRule' + description: Success + security: + - api_token: [] + tags: + - Policy + put: + description: Updates a policy rule. + operationId: updatePolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRule' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRule' + description: Success + security: + - api_token: [] + tags: + - Policy + x-codegen-request-body-name: policyRule + /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate: + post: + description: Activates a policy rule. + operationId: activatePolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - Policy + /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate: + post: + description: Deactivates a policy rule. + operationId: deactivatePolicyRule + parameters: + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: ruleId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - Policy +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Policy.yaml.sig b/test/registry/src/okta/v1/services/Policy.yaml.sig new file mode 100644 index 00000000..802e2832 --- /dev/null +++ b/test/registry/src/okta/v1/services/Policy.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmMHJQMAKUcBdm4Vz40eMubvZebNnG1hzWE3Mv0edNd9EwtDWv4iCpDzQa771QWL1Yr+/qSp82ZLYWyxkOgWx2TdM422miDA== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/ProfileMapping.yaml b/test/registry/src/okta/v1/services/ProfileMapping.yaml new file mode 100644 index 00000000..f370541d --- /dev/null +++ b/test/registry/src/okta/v1/services/ProfileMapping.yaml @@ -0,0 +1,219 @@ +components: + schemas: + ProfileMapping: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + id: + readOnly: true + type: string + properties: + additionalProperties: + $ref: '#/components/schemas/ProfileMappingProperty' + readOnly: true + type: object + source: + $ref: '#/components/schemas/ProfileMappingSource' + target: + $ref: '#/components/schemas/ProfileMappingSource' + type: object + x-okta-crud: + - alias: read + arguments: + - dest: mappingId + src: id + operationId: getProfileMapping + - alias: update + arguments: + - dest: mappingId + src: id + operationId: updateProfileMapping + x-okta-tags: + - ProfileMapping + ProfileMappingProperty: + properties: + expression: + type: string + pushStatus: + $ref: '#/components/schemas/ProfileMappingPropertyPushStatus' + type: object + x-okta-tags: + - ProfileMapping + ProfileMappingPropertyPushStatus: + enum: + - PUSH + - DONT_PUSH + type: object + x-okta-tags: + - ProfileMapping + ProfileMappingSource: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + id: + readOnly: true + type: string + name: + readOnly: true + type: string + type: + readOnly: true + type: string + type: object + x-okta-tags: + - ProfileMapping + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + mappings: + id: okta.profilemapping.mappings + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/mappings/{mappingId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/mappings/{mappingId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/mappings + response: + mediaType: application/json + openAPIDocKey: '200' + name: mappings + title: mappings +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/mappings: + get: + description: Enumerates Profile Mappings in your organization with pagination. + operationId: listProfileMappings + parameters: + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + - in: query + name: sourceId + schema: + type: string + - in: query + name: targetId + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ProfileMapping' + type: array + description: Success + security: + - api_token: [] + tags: + - ProfileMapping + /api/v1/mappings/{mappingId}: + get: + description: Fetches a single Profile Mapping referenced by its ID. + operationId: getProfileMapping + parameters: + - in: path + name: mappingId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProfileMapping' + description: Success + security: + - api_token: [] + summary: Get Profile Mapping + tags: + - ProfileMapping + post: + description: Updates an existing Profile Mapping by adding, updating, or removing + one or many Property Mappings. + operationId: updateProfileMapping + parameters: + - in: path + name: mappingId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProfileMapping' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProfileMapping' + description: Success + security: + - api_token: [] + summary: Update Profile Mapping + tags: + - ProfileMapping + x-codegen-request-body-name: profileMapping +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/ProfileMapping.yaml.sig b/test/registry/src/okta/v1/services/ProfileMapping.yaml.sig new file mode 100644 index 00000000..35455ae2 --- /dev/null +++ b/test/registry/src/okta/v1/services/ProfileMapping.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmKJv7GAKUnqcGKxFWuukPVWN+nduu4r0Yraeu8LxIGL6sqIP88SAuokzp2oy1kQCuF76mTjSJqmcPkcQW9VB8QhHxaRUOAg== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Session.yaml b/test/registry/src/okta/v1/services/Session.yaml new file mode 100644 index 00000000..70553d3b --- /dev/null +++ b/test/registry/src/okta/v1/services/Session.yaml @@ -0,0 +1,266 @@ +components: + schemas: + CreateSessionRequest: + properties: + sessionToken: + type: string + type: object + x-okta-tags: + - Session + Session: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + amr: + items: + $ref: '#/components/schemas/SessionAuthenticationMethod' + readOnly: true + type: array + createdAt: + format: date-time + readOnly: true + type: string + expiresAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + idp: + $ref: '#/components/schemas/SessionIdentityProvider' + lastFactorVerification: + format: date-time + readOnly: true + type: string + lastPasswordVerification: + format: date-time + readOnly: true + type: string + login: + readOnly: true + type: string + status: + $ref: '#/components/schemas/SessionStatus' + userId: + readOnly: true + type: string + type: object + x-okta-crud: + - alias: read + arguments: + - dest: sessionId + src: id + operationId: getSession + - alias: delete + arguments: + - dest: sessionId + src: id + operationId: endSession + x-okta-operations: + - alias: refresh + arguments: + - dest: sessionId + src: id + operationId: refreshSession + x-okta-tags: + - Session + SessionAuthenticationMethod: + enum: + - pwd + - swk + - hwk + - otp + - sms + - tel + - geo + - fpt + - kba + - mfa + type: string + x-okta-tags: + - Session + SessionIdentityProvider: + properties: + id: + readOnly: true + type: string + type: + $ref: '#/components/schemas/SessionIdentityProviderType' + type: object + x-okta-tags: + - Session + SessionIdentityProviderType: + enum: + - ACTIVE_DIRECTORY + - LDAP + - OKTA + - FEDERATION + - SOCIAL + type: string + x-okta-tags: + - Session + SessionStatus: + enum: + - ACTIVE + - MFA_ENROLL + - MFA_REQUIRED + type: string + x-okta-tags: + - Session + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + sessions: + id: okta.session.sessions + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/sessions/{sessionId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/sessions/{sessionId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/sessions + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + refresh: + operation: + $ref: POST + path: + $ref: /api/v1/sessions/{sessionId}/lifecycle/refresh + response: + mediaType: application/json + openAPIDocKey: '200' + name: sessions + title: sessions +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/sessions: + post: + description: Creates a new session for a user with a valid session token. Use + this API if, for example, you want to set the session cookie yourself instead + of allowing Okta to set it, or want to hold the session ID in order to delete + a session via the API instead of visiting the logout URL. + operationId: createSession + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSessionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Session' + description: Success + security: + - api_token: [] + summary: Create Session with Session Token + tags: + - Session + x-codegen-request-body-name: createSessionRequest + /api/v1/sessions/{sessionId}: + delete: + operationId: endSession + parameters: + - in: path + name: sessionId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Close Session + tags: + - Session + get: + description: Get details about a session. + operationId: getSession + parameters: + - in: path + name: sessionId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Session' + description: Success + security: + - api_token: [] + tags: + - Session + /api/v1/sessions/{sessionId}/lifecycle/refresh: + post: + operationId: refreshSession + parameters: + - in: path + name: sessionId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Session' + description: Success + security: + - api_token: [] + summary: Refresh Session + tags: + - Session +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Session.yaml.sig b/test/registry/src/okta/v1/services/Session.yaml.sig new file mode 100644 index 00000000..affb545f --- /dev/null +++ b/test/registry/src/okta/v1/services/Session.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmJot2UAKUiIZnUKaB/XMq9+vDFam0qO26MmHmW+N6EirNmWlBYaEn6feMneoieTn/D1ISt1Jo59wHIyeAP/avL/EINhH1CA== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/Template.yaml b/test/registry/src/okta/v1/services/Template.yaml new file mode 100644 index 00000000..502069b9 --- /dev/null +++ b/test/registry/src/okta/v1/services/Template.yaml @@ -0,0 +1,297 @@ +components: + schemas: + SmsTemplate: + properties: + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + template: + type: string + translations: + $ref: '#/components/schemas/SmsTemplateTranslations' + type: + $ref: '#/components/schemas/SmsTemplateType' + type: object + x-okta-crud: + - alias: create + arguments: + - dest: smsTemplate + self: true + operationId: createSmsTemplate + - alias: read + arguments: [] + operationId: getSmsTemplate + - alias: update + arguments: + - dest: templateId + src: id + - dest: smsTemplate + self: true + operationId: updateSmsTemplate + - alias: delete + arguments: + - dest: templateId + src: id + operationId: deleteSmsTemplate + x-okta-operations: + - alias: partialUpdate + arguments: + - dest: templateId + src: id + - dest: smsTemplate + self: true + operationId: partialUpdateSmsTemplate + x-okta-tags: + - Template + SmsTemplateTranslations: + type: object + x-okta-extensible: true + x-okta-tags: + - Template + SmsTemplateType: + enum: + - SMS_VERIFY_CODE + type: string + x-okta-tags: + - Template + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + sms: + id: okta.template.sms + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/templates/sms/{templateId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/templates/sms/{templateId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/templates/sms + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/templates/sms + response: + mediaType: application/json + openAPIDocKey: '200' + partialUpdate: + operation: + $ref: POST + path: + $ref: /api/v1/templates/sms/{templateId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/templates/sms/{templateId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: sms + title: sms +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/templates/sms: + get: + description: Enumerates custom SMS templates in your organization. A subset + of templates can be returned that match a template type. + operationId: listSmsTemplates + parameters: + - in: query + name: templateType + schema: + type: string + x-openapi-v3-schema-ref: '#/components/schemas/SmsTemplateType' + x-openapi-v3-schema-ref: '#/components/schemas/SmsTemplateType' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SmsTemplate' + type: array + description: Success + security: + - api_token: [] + summary: List SMS Templates + tags: + - Template + post: + description: Adds a new custom SMS template to your organization. + operationId: createSmsTemplate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmsTemplate' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SmsTemplate' + description: Success + security: + - api_token: [] + summary: Add SMS Template + tags: + - Template + x-codegen-request-body-name: smsTemplate + /api/v1/templates/sms/{templateId}: + delete: + description: Removes an SMS template. + operationId: deleteSmsTemplate + parameters: + - in: path + name: templateId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Remove SMS Template + tags: + - Template + get: + description: Fetches a specific template by `id` + operationId: getSmsTemplate + parameters: + - in: path + name: templateId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SmsTemplate' + description: Success + security: + - api_token: [] + summary: Get SMS Template + tags: + - Template + post: + description: 'Updates only some of the SMS template properties:' + operationId: partialUpdateSmsTemplate + parameters: + - in: path + name: templateId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmsTemplate' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SmsTemplate' + description: Success + security: + - api_token: [] + summary: Partial SMS Template Update + tags: + - Template + x-codegen-request-body-name: smsTemplate + put: + description: Updates the SMS template. + operationId: updateSmsTemplate + parameters: + - in: path + name: templateId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmsTemplate' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SmsTemplate' + description: Success + security: + - api_token: [] + summary: Update SMS Template + tags: + - Template + x-codegen-request-body-name: smsTemplate +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/Template.yaml.sig b/test/registry/src/okta/v1/services/Template.yaml.sig new file mode 100644 index 00000000..a86590a3 --- /dev/null +++ b/test/registry/src/okta/v1/services/Template.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmLLTLMAKUDlJq4lnBtHY1XYgouOYfZ4HV3lPtmXtrZy3onJDzGznnPdDzeeII2nyWAEvftMb//fyQ7l9TxAcGXd2zaCHWAQ== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/ThreatInsight.yaml b/test/registry/src/okta/v1/services/ThreatInsight.yaml new file mode 100644 index 00000000..e93b1fb6 --- /dev/null +++ b/test/registry/src/okta/v1/services/ThreatInsight.yaml @@ -0,0 +1,114 @@ +components: + schemas: + ThreatInsightConfiguration: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + action: + type: string + created: + format: date-time + readOnly: true + type: string + excludeZones: + items: + type: string + type: array + lastUpdated: + format: date-time + readOnly: true + type: string + type: object + x-okta-crud: + - alias: read + arguments: [] + operationId: getCurrentConfiguration + - alias: update + arguments: + - dest: threatInsightConfiguration + self: true + operationId: updateConfiguration + x-okta-tags: + - ThreatInsight + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + configuration: + id: okta.threatinsight.configuration + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/threats/configuration + response: + mediaType: application/json + openAPIDocKey: '200' + name: configuration + title: configuration +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/threats/configuration: + get: + description: Gets current ThreatInsight configuration + operationId: getCurrentConfiguration + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ThreatInsightConfiguration' + description: Success + security: + - api_token: [] + tags: + - ThreatInsight + post: + description: Updates ThreatInsight configuration + operationId: updateConfiguration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ThreatInsightConfiguration' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ThreatInsightConfiguration' + description: Success + security: + - api_token: [] + tags: + - ThreatInsight + x-codegen-request-body-name: ThreatInsightConfiguration +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/ThreatInsight.yaml.sig b/test/registry/src/okta/v1/services/ThreatInsight.yaml.sig new file mode 100644 index 00000000..c0a3e510 --- /dev/null +++ b/test/registry/src/okta/v1/services/ThreatInsight.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmNSaZEAKUKCeOx2Nm2M8SxlDCMukMTRmLU7RIWpXwLQsjkfSX+7iEKQOehtLFqdgLlqR/S3UZlSByonDppmOmcUwBcB1iCQ== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/TrustedOrigin.yaml b/test/registry/src/okta/v1/services/TrustedOrigin.yaml new file mode 100644 index 00000000..a49eed9c --- /dev/null +++ b/test/registry/src/okta/v1/services/TrustedOrigin.yaml @@ -0,0 +1,332 @@ +components: + schemas: + Scope: + properties: + stringValue: + type: string + type: + $ref: '#/components/schemas/ScopeType' + type: object + x-okta-tags: + - Role + ScopeType: + enum: + - CORS + - REDIRECT + type: string + x-okta-tags: + - Role + TrustedOrigin: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + createdBy: + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + lastUpdatedBy: + type: string + name: + type: string + origin: + type: string + scopes: + items: + $ref: '#/components/schemas/Scope' + type: array + status: + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: trustedOrigin + self: true + operationId: createOrigin + - alias: read + arguments: [] + operationId: getOrigin + - alias: update + arguments: + - dest: trustedOriginId + src: id + - dest: trustedOrigin + self: true + operationId: updateOrigin + - alias: delete + arguments: + - dest: trustedOriginId + src: id + operationId: deleteOrigin + x-okta-tags: + - TrustedOrigin + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + trustedorigins: + id: okta.trustedorigin.trustedorigins + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/trustedOrigins/{trustedOriginId} + response: + openAPIDocKey: '200' + get: + operation: + $ref: GET + path: + $ref: /api/v1/trustedOrigins/{trustedOriginId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/trustedOrigins + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/trustedOrigins + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/trustedOrigins/{trustedOriginId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: trustedorigins + title: trustedorigins +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/trustedOrigins: + get: + description: Success + operationId: listOrigins + parameters: + - in: query + name: q + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/TrustedOrigin' + type: array + description: Success + security: + - api_token: [] + tags: + - TrustedOrigin + post: + description: Success + operationId: createOrigin + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrustedOrigin' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TrustedOrigin' + description: Success + security: + - api_token: [] + tags: + - TrustedOrigin + x-codegen-request-body-name: trustedOrigin + /api/v1/trustedOrigins/{trustedOriginId}: + delete: + description: Success + operationId: deleteOrigin + parameters: + - in: path + name: trustedOriginId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - TrustedOrigin + get: + description: Success + operationId: getOrigin + parameters: + - in: path + name: trustedOriginId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TrustedOrigin' + description: Success + security: + - api_token: [] + tags: + - TrustedOrigin + put: + description: Success + operationId: updateOrigin + parameters: + - in: path + name: trustedOriginId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrustedOrigin' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TrustedOrigin' + description: Success + security: + - api_token: [] + tags: + - TrustedOrigin + x-codegen-request-body-name: trustedOrigin + /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate: + post: + description: Success + operationId: activateOrigin + parameters: + - in: path + name: trustedOriginId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TrustedOrigin' + description: Success + security: + - api_token: [] + tags: + - TrustedOrigin + /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate: + post: + description: Success + operationId: deactivateOrigin + parameters: + - in: path + name: trustedOriginId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TrustedOrigin' + description: Success + security: + - api_token: [] + tags: + - TrustedOrigin +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/TrustedOrigin.yaml.sig b/test/registry/src/okta/v1/services/TrustedOrigin.yaml.sig new file mode 100644 index 00000000..96efa84b --- /dev/null +++ b/test/registry/src/okta/v1/services/TrustedOrigin.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnEqaREAKUcRFGcnD8MrSfL0XluqnMY2PImVryztPAWw37TWrxz06afytmR7mGCiagLZROTBd8jtQ087FKkGQQYsdTSxDdBA== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/User.yaml b/test/registry/src/okta/v1/services/User.yaml new file mode 100644 index 00000000..a5971cc7 --- /dev/null +++ b/test/registry/src/okta/v1/services/User.yaml @@ -0,0 +1,4281 @@ +components: + schemas: + AppAndInstanceConditionEvaluatorAppOrInstance: + properties: + id: + readOnly: true + type: string + name: + type: string + type: + enum: + - APP_TYPE + - APP + type: string + type: object + x-okta-tags: + - Policy + AppAndInstancePolicyRuleCondition: + properties: + exclude: + items: + $ref: '#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance' + type: array + include: + items: + $ref: '#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance' + type: array + type: object + x-okta-tags: + - Policy + AppInstancePolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + AppLink: + properties: + appAssignmentId: + readOnly: true + type: string + appInstanceId: + readOnly: true + type: string + appName: + readOnly: true + type: string + credentialsSetup: + readOnly: true + type: boolean + hidden: + readOnly: true + type: boolean + id: + readOnly: true + type: string + label: + readOnly: true + type: string + linkUrl: + readOnly: true + type: string + logoUrl: + readOnly: true + type: string + sortOrder: + readOnly: true + type: integer + type: object + x-okta-tags: + - User + AssignRoleRequest: + properties: + type: + $ref: '#/components/schemas/RoleType' + type: object + x-okta-tags: + - Role + AuthenticationProvider: + properties: + name: + type: string + type: + $ref: '#/components/schemas/AuthenticationProviderType' + type: object + x-okta-tags: + - User + AuthenticationProviderType: + enum: + - ACTIVE_DIRECTORY + - FEDERATION + - LDAP + - OKTA + - SOCIAL + - IMPORT + type: string + x-okta-tags: + - User + BeforeScheduledActionPolicyRuleCondition: + properties: + duration: + $ref: '#/components/schemas/Duration' + lifecycleAction: + $ref: '#/components/schemas/ScheduledUserLifecycleAction' + type: object + x-okta-tags: + - Policy + CatalogApplication: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + category: + type: string + description: + type: string + displayName: + type: string + features: + items: + type: string + type: array + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + signOnModes: + items: + type: string + type: array + status: + $ref: '#/components/schemas/CatalogApplicationStatus' + verificationStatus: + type: string + website: + type: string + type: object + x-okta-tags: + - Role + CatalogApplicationStatus: + enum: + - ACTIVE + - INACTIVE + type: string + x-okta-tags: + - Role + ChangePasswordRequest: + properties: + newPassword: + $ref: '#/components/schemas/PasswordCredential' + oldPassword: + $ref: '#/components/schemas/PasswordCredential' + type: object + x-okta-tags: + - User + ClientPolicyCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + ContextPolicyRuleCondition: + properties: + expression: + type: string + type: object + x-okta-tags: + - Policy + CreateUserRequest: + properties: + credentials: + $ref: '#/components/schemas/UserCredentials' + groupIds: + items: + type: string + type: array + profile: + $ref: '#/components/schemas/UserProfile' + type: + $ref: '#/components/schemas/UserType' + type: object + x-okta-tags: + - User + DevicePolicyRuleCondition: + properties: + migrated: + type: boolean + platform: + $ref: '#/components/schemas/DevicePolicyRuleConditionPlatform' + rooted: + type: boolean + trustLevel: + enum: + - ANY + - TRUSTED + type: string + type: object + x-okta-tags: + - Policy + DevicePolicyRuleConditionPlatform: + properties: + supportedMDMFrameworks: + items: + enum: + - AFW + - SAFE + - NATIVE + type: string + type: array + types: + items: + enum: + - IOS + - ANDROID + - OSX + - WINDOWS + type: string + type: array + type: object + x-okta-tags: + - Policy + Duration: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + ForgotPasswordResponse: + properties: + resetPasswordUrl: + readOnly: true + type: string + type: object + x-okta-tags: + - User + GrantTypePolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + Group: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + lastMembershipUpdated: + format: date-time + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + objectClass: + items: + type: string + readOnly: true + type: array + profile: + $ref: '#/components/schemas/GroupProfile' + type: + $ref: '#/components/schemas/GroupType' + type: object + x-okta-crud: + - alias: update + arguments: + - dest: groupId + src: id + - dest: group + self: true + operationId: updateGroup + - alias: delete + arguments: + - dest: groupId + src: id + operationId: deleteGroup + x-okta-operations: + - alias: removeUser + arguments: + - dest: groupId + src: id + operationId: removeUserFromGroup + - alias: listUsers + arguments: + - dest: groupId + src: id + operationId: listGroupUsers + - alias: listApplications + arguments: + - dest: groupId + src: id + operationId: listAssignedApplicationsForGroup + - alias: assignRole + arguments: + - dest: groupId + src: id + operationId: assignRoleToGroup + x-okta-tags: + - Group + GroupCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + GroupPolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + GroupProfile: + properties: + description: + type: string + name: + type: string + type: object + x-okta-extensible: true + x-okta-tags: + - Group + GroupType: + enum: + - OKTA_GROUP + - APP_GROUP + - BUILT_IN + type: string + x-okta-tags: + - Group + IdentityProvider: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + issuerMode: + enum: + - ORG_URL + - CUSTOM_URL + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + policy: + $ref: '#/components/schemas/IdentityProviderPolicy' + protocol: + $ref: '#/components/schemas/Protocol' + status: + enum: + - ACTIVE + - INACTIVE + type: string + type: + enum: + - SAML2 + - GOOGLE + - FACEBOOK + - LINKEDIN + - MICROSOFT + - OIDC + - OKTA + - IWA + - AgentlessDSSO + - X509 + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: idpTrust + self: true + operationId: createIdentityProvider + - alias: read + arguments: [] + operationId: getIdentityProvider + - alias: update + arguments: + - dest: idpId + src: id + - dest: idpTrust + self: true + operationId: updateIdentityProvider + - alias: delete + arguments: + - dest: idpId + src: id + operationId: deleteIdentityProvider + x-okta-operations: + - alias: listSigningCsrs + arguments: + - dest: idpId + src: id + operationId: listCsrsForIdentityProvider + - alias: generateCsr + arguments: + - dest: idpId + src: id + operationId: generateCsrForIdentityProvider + - alias: deleteSigningCsr + arguments: + - dest: idpId + src: id + operationId: revokeCsrForIdentityProvider + - alias: getSigningCsr + arguments: + - dest: idpId + src: id + operationId: getCsrForIdentityProvider + - alias: listSigningKeys + arguments: + - dest: idpId + src: id + operationId: listIdentityProviderSigningKeys + - alias: generateSigningKey + arguments: + - dest: idpId + src: id + operationId: generateIdentityProviderSigningKey + - alias: getSigningKey + arguments: + - dest: idpId + src: id + operationId: getIdentityProviderSigningKey + - alias: cloneKey + arguments: + - dest: idpId + src: id + operationId: cloneIdentityProviderKey + - alias: activate + arguments: + - dest: idpId + src: id + operationId: activateIdentityProvider + - alias: deactivate + arguments: + - dest: idpId + src: id + operationId: deactivateIdentityProvider + - alias: listUsers + arguments: + - dest: idpId + src: id + operationId: listIdentityProviderApplicationUsers + - alias: unlinkUser + arguments: + - dest: idpId + src: id + operationId: unlinkUserFromIdentityProvider + - alias: getUser + arguments: + - dest: idpId + src: id + operationId: getIdentityProviderApplicationUser + - alias: linkUser + arguments: + - dest: idpId + src: id + operationId: linkUserToIdentityProvider + - alias: listSocialAuthTokens + arguments: + - dest: idpId + src: id + operationId: listSocialAuthTokens + x-okta-tags: + - IdentityProvider + IdentityProviderCredentials: + properties: + client: + $ref: '#/components/schemas/IdentityProviderCredentialsClient' + signing: + $ref: '#/components/schemas/IdentityProviderCredentialsSigning' + trust: + $ref: '#/components/schemas/IdentityProviderCredentialsTrust' + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderCredentialsClient: + properties: + client_id: + type: string + client_secret: + type: string + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderCredentialsSigning: + properties: + kid: + type: string + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderCredentialsTrust: + properties: + audience: + type: string + issuer: + type: string + kid: + type: string + revocation: + enum: + - CRL + - DELTA_CRL + - OCSP + type: string + revocationCacheLifetime: + type: integer + type: object + x-okta-tags: + - IdentityProvider + IdentityProviderPolicy: + properties: + accountLink: + $ref: '#/components/schemas/PolicyAccountLink' + maxClockSkew: + type: integer + provisioning: + $ref: '#/components/schemas/Provisioning' + subject: + $ref: '#/components/schemas/PolicySubject' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + IdentityProviderPolicyRuleCondition: + properties: + idpIds: + items: + type: string + type: array + provider: + enum: + - ANY + - OKTA + - SPECIFIC_IDP + type: string + type: object + x-okta-tags: + - Policy + InactivityPolicyRuleCondition: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + LifecycleExpirationPolicyRuleCondition: + properties: + lifecycleStatus: + type: string + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + MDMEnrollmentPolicyRuleCondition: + properties: + blockNonSafeAndroid: + type: boolean + enrollment: + enum: + - OMM + - ANY_OR_NONE + type: string + type: object + x-okta-tags: + - Policy + OAuth2Actor: + properties: + id: + readOnly: true + type: string + type: + type: string + type: object + x-okta-tags: + - Application + OAuth2Client: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + client_id: + readOnly: true + type: string + client_name: + readOnly: true + type: string + client_uri: + readOnly: true + type: string + logo_uri: + readOnly: true + type: string + type: object + x-okta-tags: + - Application + OAuth2RefreshToken: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + clientId: + type: string + created: + format: date-time + readOnly: true + type: string + createdBy: + $ref: '#/components/schemas/OAuth2Actor' + expiresAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + issuer: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + scopes: + items: + type: string + type: array + status: + enum: + - ACTIVE + - REVOKED + type: string + userId: + type: string + type: object + x-okta-tags: + - Application + OAuth2ScopeConsentGrant: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + clientId: + type: string + created: + format: date-time + readOnly: true + type: string + createdBy: + $ref: '#/components/schemas/OAuth2Actor' + id: + readOnly: true + type: string + issuer: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + scopeId: + type: string + source: + $ref: '#/components/schemas/OAuth2ScopeConsentGrantSource' + status: + $ref: '#/components/schemas/OAuth2ScopeConsentGrantStatus' + userId: + type: string + type: object + x-okta-tags: + - Application + OAuth2ScopeConsentGrantSource: + enum: + - END_USER + - ADMIN + type: string + x-okta-tags: + - Application + OAuth2ScopeConsentGrantStatus: + enum: + - ACTIVE + - REVOKED + type: string + x-okta-tags: + - Application + OAuth2ScopesMediationPolicyRuleCondition: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Application + OAuthAuthorizationPolicy: + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + OktaSignOnPolicy: + properties: + conditions: + $ref: '#/components/schemas/OktaSignOnPolicyConditions' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + OktaSignOnPolicyConditions: + properties: + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleConditions' + x-okta-tags: + - Policy + PasswordCredential: + properties: + hash: + $ref: '#/components/schemas/PasswordCredentialHash' + hook: + $ref: '#/components/schemas/PasswordCredentialHook' + value: + format: password + type: string + type: object + x-okta-tags: + - User + PasswordCredentialHash: + properties: + algorithm: + $ref: '#/components/schemas/PasswordCredentialHashAlgorithm' + salt: + type: string + saltOrder: + type: string + value: + type: string + workFactor: + type: integer + type: object + x-okta-tags: + - User + PasswordCredentialHashAlgorithm: + enum: + - BCRYPT + - SHA-512 + - SHA-256 + - SHA-1 + - MD5 + type: string + x-okta-tags: + - User + PasswordCredentialHook: + properties: + type: + type: string + type: object + x-okta-tags: + - User + PasswordDictionary: + properties: + common: + $ref: '#/components/schemas/PasswordDictionaryCommon' + type: object + x-okta-tags: + - Policy + PasswordDictionaryCommon: + properties: + exclude: + default: false + type: boolean + type: object + x-okta-tags: + - Policy + PasswordExpirationPolicyRuleCondition: + properties: + number: + type: integer + unit: + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicy: + properties: + conditions: + $ref: '#/components/schemas/PasswordPolicyConditions' + settings: + $ref: '#/components/schemas/PasswordPolicySettings' + type: object + x-okta-parent: '#/components/schemas/Policy' + x-okta-tags: + - Policy + PasswordPolicyAuthenticationProviderCondition: + properties: + include: + items: + type: string + type: array + provider: + enum: + - ACTIVE_DIRECTORY + - ANY + - LDAP + - OKTA + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyConditions: + properties: + authProvider: + $ref: '#/components/schemas/PasswordPolicyAuthenticationProviderCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + type: object + x-okta-parent: '#/components/schemas/PolicyRuleConditions' + x-okta-tags: + - Policy + PasswordPolicyDelegationSettings: + properties: + options: + $ref: '#/components/schemas/PasswordPolicyDelegationSettingsOptions' + type: object + x-okta-tags: + - Policy + PasswordPolicyDelegationSettingsOptions: + properties: + skipUnlock: + type: boolean + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettings: + properties: + age: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsAge' + complexity: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsComplexity' + lockout: + $ref: '#/components/schemas/PasswordPolicyPasswordSettingsLockout' + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsAge: + properties: + expireWarnDays: + type: integer + historyCount: + type: integer + maxAgeDays: + type: integer + minAgeMinutes: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsComplexity: + properties: + dictionary: + $ref: '#/components/schemas/PasswordDictionary' + excludeAttributes: + items: + type: string + type: array + excludeUsername: + default: true + type: boolean + minLength: + type: integer + minLowerCase: + type: integer + minNumber: + type: integer + minSymbol: + type: integer + minUpperCase: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyPasswordSettingsLockout: + properties: + autoUnlockMinutes: + type: integer + maxAttempts: + type: integer + showLockoutFailures: + type: boolean + userLockoutNotificationChannels: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmail: + properties: + properties: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmailProperties' + status: + enum: + - ACTIVE + - INACTIVE + readOnly: true + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmailProperties: + properties: + recoveryToken: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmailRecoveryToken' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryEmailRecoveryToken: + properties: + tokenLifetimeMinutes: + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryFactorSettings: + properties: + status: + default: INACTIVE + enum: + - ACTIVE + - INACTIVE + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryFactors: + properties: + okta_call: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactorSettings' + okta_email: + $ref: '#/components/schemas/PasswordPolicyRecoveryEmail' + okta_sms: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactorSettings' + recovery_question: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestion' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestion: + properties: + properties: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestionProperties' + status: + enum: + - ACTIVE + - INACTIVE + readOnly: true + type: string + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestionComplexity: + properties: + minLength: + readOnly: true + type: integer + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoveryQuestionProperties: + properties: + complexity: + $ref: '#/components/schemas/PasswordPolicyRecoveryQuestionComplexity' + type: object + x-okta-tags: + - Policy + PasswordPolicyRecoverySettings: + properties: + factors: + $ref: '#/components/schemas/PasswordPolicyRecoveryFactors' + type: object + x-okta-tags: + - Policy + PasswordPolicySettings: + properties: + delegation: + $ref: '#/components/schemas/PasswordPolicyDelegationSettings' + password: + $ref: '#/components/schemas/PasswordPolicyPasswordSettings' + recovery: + $ref: '#/components/schemas/PasswordPolicyRecoverySettings' + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatform: + properties: + os: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystem' + type: + enum: + - DESKTOP + - MOBILE + - OTHER + - ANY + type: string + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatformOperatingSystem: + properties: + expression: + type: string + type: + enum: + - ANDROID + - IOS + - WINDOWS + - OSX + - OTHER + - ANY + type: string + version: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion' + type: object + x-okta-tags: + - Policy + PlatformConditionEvaluatorPlatformOperatingSystemVersion: + properties: + matchType: + enum: + - EXPRESSION + - SEMVER + type: string + value: + type: string + type: object + x-okta-tags: + - Policy + PlatformPolicyRuleCondition: + properties: + exclude: + items: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatform' + type: array + include: + items: + $ref: '#/components/schemas/PlatformConditionEvaluatorPlatform' + type: array + type: object + x-okta-tags: + - Policy + Policy: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + conditions: + $ref: '#/components/schemas/PolicyRuleConditions' + created: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + name: + type: string + priority: + type: integer + status: + enum: + - ACTIVE + - INACTIVE + type: string + system: + type: boolean + type: + $ref: '#/components/schemas/PolicyType' + type: object + x-okta-crud: + - alias: read + arguments: + - dest: policyId + src: id + operationId: getPolicy + - alias: update + arguments: + - dest: policyId + src: id + - dest: policy + self: true + operationId: updatePolicy + - alias: delete + arguments: + - dest: policyId + src: id + operationId: deletePolicy + x-okta-operations: + - alias: activate + arguments: + - dest: policyId + src: id + operationId: activatePolicy + - alias: deactivate + arguments: + - dest: policyId + src: id + operationId: deactivatePolicy + - alias: listPolicyRules + arguments: + - dest: policyId + src: id + operationId: listPolicyRules + - alias: createRule + arguments: + - dest: policyId + src: id + operationId: createPolicyRule + - alias: getPolicyRule + arguments: + - dest: policyId + src: id + operationId: getPolicyRule + x-okta-tags: + - Policy + x-openapi-v3-discriminator: + mapping: + IDP_DISCOVERY: '#/components/schemas/IdentityProviderPolicy' + OAUTH_AUTHORIZATION_POLICY: '#/components/schemas/OAuthAuthorizationPolicy' + OKTA_SIGN_ON: '#/components/schemas/OktaSignOnPolicy' + PASSWORD: '#/components/schemas/PasswordPolicy' + propertyName: type + PolicyAccountLink: + properties: + action: + enum: + - AUTO + - DISABLED + type: string + filter: + $ref: '#/components/schemas/PolicyAccountLinkFilter' + type: object + x-okta-tags: + - Policy + PolicyAccountLinkFilter: + properties: + groups: + $ref: '#/components/schemas/PolicyAccountLinkFilterGroups' + type: object + x-okta-tags: + - Policy + PolicyAccountLinkFilterGroups: + properties: + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PolicyNetworkCondition: + properties: + connection: + enum: + - ANYWHERE + - ZONE + type: string + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + PolicyPeopleCondition: + properties: + groups: + $ref: '#/components/schemas/GroupCondition' + users: + $ref: '#/components/schemas/UserCondition' + type: object + x-okta-tags: + - Policy + PolicyRuleAuthContextCondition: + properties: + authType: + enum: + - ANY + - RADIUS + type: string + type: object + x-okta-tags: + - Policy + PolicyRuleConditions: + properties: + app: + $ref: '#/components/schemas/AppAndInstancePolicyRuleCondition' + apps: + $ref: '#/components/schemas/AppInstancePolicyRuleCondition' + authContext: + $ref: '#/components/schemas/PolicyRuleAuthContextCondition' + authProvider: + $ref: '#/components/schemas/PasswordPolicyAuthenticationProviderCondition' + beforeScheduledAction: + $ref: '#/components/schemas/BeforeScheduledActionPolicyRuleCondition' + clients: + $ref: '#/components/schemas/ClientPolicyCondition' + context: + $ref: '#/components/schemas/ContextPolicyRuleCondition' + device: + $ref: '#/components/schemas/DevicePolicyRuleCondition' + grantTypes: + $ref: '#/components/schemas/GrantTypePolicyRuleCondition' + groups: + $ref: '#/components/schemas/GroupPolicyRuleCondition' + identityProvider: + $ref: '#/components/schemas/IdentityProviderPolicyRuleCondition' + mdmEnrollment: + $ref: '#/components/schemas/MDMEnrollmentPolicyRuleCondition' + network: + $ref: '#/components/schemas/PolicyNetworkCondition' + people: + $ref: '#/components/schemas/PolicyPeopleCondition' + platform: + $ref: '#/components/schemas/PlatformPolicyRuleCondition' + risk: + $ref: '#/components/schemas/RiskPolicyRuleCondition' + riskScore: + $ref: '#/components/schemas/RiskScorePolicyRuleCondition' + scopes: + $ref: '#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition' + userIdentifier: + $ref: '#/components/schemas/UserIdentifierPolicyRuleCondition' + userStatus: + $ref: '#/components/schemas/UserStatusPolicyRuleCondition' + users: + $ref: '#/components/schemas/UserPolicyRuleCondition' + type: object + x-okta-tags: + - Policy + PolicySubject: + properties: + filter: + type: string + format: + items: + type: string + type: array + matchAttribute: + type: string + matchType: + $ref: '#/components/schemas/PolicySubjectMatchType' + userNameTemplate: + $ref: '#/components/schemas/PolicyUserNameTemplate' + type: object + x-okta-tags: + - Policy + PolicySubjectMatchType: + enum: + - USERNAME + - EMAIL + - USERNAME_OR_EMAIL + - CUSTOM_ATTRIBUTE + type: string + x-okta-tags: + - Policy + PolicyType: + enum: + - OAUTH_AUTHORIZATION_POLICY + - OKTA_SIGN_ON + - PASSWORD + - IDP_DISCOVERY + type: string + x-okta-tags: + - Policy + PolicyUserNameTemplate: + properties: + template: + type: string + type: object + x-okta-tags: + - Policy + Protocol: + properties: + algorithms: + $ref: '#/components/schemas/ProtocolAlgorithms' + credentials: + $ref: '#/components/schemas/IdentityProviderCredentials' + endpoints: + $ref: '#/components/schemas/ProtocolEndpoints' + issuer: + $ref: '#/components/schemas/ProtocolEndpoint' + relayState: + $ref: '#/components/schemas/ProtocolRelayState' + scopes: + items: + type: string + type: array + settings: + $ref: '#/components/schemas/ProtocolSettings' + type: + enum: + - SAML2 + - OIDC + - OAUTH2 + - MTLS + type: string + type: object + x-okta-tags: + - IdentityProvider + ProtocolAlgorithmType: + properties: + signature: + $ref: '#/components/schemas/ProtocolAlgorithmTypeSignature' + type: object + x-okta-tags: + - IdentityProvider + ProtocolAlgorithmTypeSignature: + properties: + algorithm: + type: string + scope: + enum: + - RESPONSE + - TOKEN + - ANY + - REQUEST + - NONE + type: string + type: object + x-okta-tags: + - IdentityProvider + ProtocolAlgorithms: + properties: + request: + $ref: '#/components/schemas/ProtocolAlgorithmType' + response: + $ref: '#/components/schemas/ProtocolAlgorithmType' + type: object + x-okta-tags: + - IdentityProvider + ProtocolEndpoint: + properties: + binding: + enum: + - HTTP-POST + - HTTP-REDIRECT + type: string + destination: + type: string + type: + enum: + - INSTANCE + - ORG + type: string + url: + type: string + type: object + x-okta-tags: + - IdentityProvider + ProtocolEndpoints: + properties: + acs: + $ref: '#/components/schemas/ProtocolEndpoint' + authorization: + $ref: '#/components/schemas/ProtocolEndpoint' + jwks: + $ref: '#/components/schemas/ProtocolEndpoint' + metadata: + $ref: '#/components/schemas/ProtocolEndpoint' + slo: + $ref: '#/components/schemas/ProtocolEndpoint' + sso: + $ref: '#/components/schemas/ProtocolEndpoint' + token: + $ref: '#/components/schemas/ProtocolEndpoint' + userInfo: + $ref: '#/components/schemas/ProtocolEndpoint' + type: object + x-okta-tags: + - IdentityProvider + ProtocolRelayState: + properties: + format: + $ref: '#/components/schemas/ProtocolRelayStateFormat' + type: object + x-okta-tags: + - IdentityProvider + ProtocolRelayStateFormat: + enum: + - OPAQUE + - FROM_URL + type: string + x-okta-tags: + - IdentityProvider + ProtocolSettings: + properties: + nameFormat: + type: string + type: object + x-okta-tags: + - IdentityProvider + Provisioning: + properties: + action: + enum: + - AUTO + - CALLOUT + - DISABLED + type: string + conditions: + $ref: '#/components/schemas/ProvisioningConditions' + groups: + $ref: '#/components/schemas/ProvisioningGroups' + profileMaster: + type: boolean + type: object + x-okta-tags: + - IdentityProvider + ProvisioningConditions: + properties: + deprovisioned: + $ref: '#/components/schemas/ProvisioningDeprovisionedCondition' + suspended: + $ref: '#/components/schemas/ProvisioningSuspendedCondition' + type: object + x-okta-tags: + - IdentityProvider + ProvisioningDeprovisionedCondition: + properties: + action: + enum: + - NONE + - REACTIVATE + type: string + type: object + x-okta-tags: + - IdentityProvider + ProvisioningGroups: + properties: + action: + enum: + - NONE + - APPEND + - SYNC + - ASSIGN + type: string + assignments: + items: + type: string + type: array + filter: + items: + type: string + type: array + sourceAttributeName: + type: string + type: object + x-okta-tags: + - IdentityProvider + ProvisioningSuspendedCondition: + properties: + action: + enum: + - NONE + - UNSUSPEND + type: string + type: object + x-okta-tags: + - IdentityProvider + RecoveryQuestionCredential: + properties: + answer: + type: string + question: + type: string + type: object + x-okta-tags: + - User + ResetPasswordToken: + properties: + resetPasswordUrl: + readOnly: true + type: string + type: object + x-okta-tags: + - User + ResponseLinks: + type: object + x-okta-tags: + - User + RiskPolicyRuleCondition: + properties: + behaviors: + items: + type: string + type: array + uniqueItems: true + type: object + x-okta-tags: + - Policy + RiskScorePolicyRuleCondition: + properties: + level: + type: string + type: object + x-okta-tags: + - Policy + Role: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + assignmentType: + $ref: '#/components/schemas/RoleAssignmentType' + created: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + label: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + status: + $ref: '#/components/schemas/RoleStatus' + type: + $ref: '#/components/schemas/RoleType' + type: object + x-okta-operations: + - alias: addAdminGroupTarget + arguments: + - dest: roleId + src: id + - dest: groupId + parentSrc: id + operationId: addGroupTargetToGroupAdministratorRoleForGroup + - alias: addAppInstanceTargetToAdminRole + arguments: + - dest: roleId + src: id + - dest: groupId + parentSrc: id + operationId: addApplicationInstanceTargetToAppAdminRoleGivenToGroup + - alias: addAppTargetToAdminRole + arguments: + - dest: roleId + src: id + - dest: groupId + parentSrc: id + operationId: addApplicationTargetToAdminRoleGivenToGroup + - alias: addAllAppsAsTargetToRole + arguments: + - dest: roleId + src: id + - dest: userId + parentSrc: id + operationId: addAllAppsAsTargetToRole + - alias: addAppTargetToAppAdminRoleForUser + arguments: + - dest: roleId + src: id + - dest: userId + parentSrc: id + operationId: addApplicationTargetToAppAdminRoleForUser + - alias: addAppTargetToAdminRoleForUser + arguments: + - dest: roleId + src: id + - dest: userId + parentSrc: id + operationId: addApplicationTargetToAdminRoleForUser + x-okta-tags: + - User + RoleAssignmentType: + enum: + - GROUP + - USER + type: string + x-okta-tags: + - Role + RoleStatus: + enum: + - ACTIVE + - INACTIVE + type: string + x-okta-tags: + - User + RoleType: + enum: + - SUPER_ADMIN + - ORG_ADMIN + - APP_ADMIN + - USER_ADMIN + - HELP_DESK_ADMIN + - READ_ONLY_ADMIN + - MOBILE_ADMIN + - API_ACCESS_MANAGEMENT_ADMIN + - REPORT_ADMIN + - GROUP_MEMBERSHIP_ADMIN + type: string + x-okta-tags: + - Role + ScheduledUserLifecycleAction: + properties: + status: + enum: + - ACTIVE + - INACTIVE + - PENDING + - DELETED + - EXPIRED_PASSWORD + - ACTIVATING + - SUSPENDED + - DELETING + type: string + type: object + x-okta-tags: + - Policy + TempPassword: + properties: + tempPassword: + readOnly: true + type: string + type: object + x-okta-tags: + - User + User: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + activated: + format: date-time + readOnly: true + type: string + created: + format: date-time + readOnly: true + type: string + credentials: + $ref: '#/components/schemas/UserCredentials' + id: + readOnly: true + type: string + lastLogin: + format: date-time + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + passwordChanged: + format: date-time + readOnly: true + type: string + profile: + $ref: '#/components/schemas/UserProfile' + status: + $ref: '#/components/schemas/UserStatus' + statusChanged: + format: date-time + readOnly: true + type: string + transitioningToStatus: + $ref: '#/components/schemas/UserStatus' + type: + $ref: '#/components/schemas/UserType' + type: object + x-okta-crud: + - alias: create + arguments: + - dest: user + self: true + operationId: createUser + - alias: read + arguments: [] + operationId: getUser + - alias: update + arguments: + - dest: userId + src: id + - dest: user + self: true + operationId: updateUser + - alias: delete + arguments: + - dest: userId + src: id + - dest: user + self: true + operationId: deactivateOrDeleteUser + x-okta-operations: + - alias: listAppLinks + arguments: + - dest: userId + src: id + operationId: listAppLinks + - alias: changePassword + arguments: + - dest: userId + src: id + operationId: changePassword + - alias: changeRecoveryQuestion + arguments: + - dest: userId + src: id + operationId: changeRecoveryQuestion + - alias: forgotPasswordSetNewPassword + arguments: + - dest: userId + src: id + operationId: forgotPasswordSetNewPassword + - alias: forgotPasswordGenerateOneTimeToken + arguments: + - dest: userId + src: id + operationId: forgotPasswordGenerateOneTimeToken + - alias: assignRole + arguments: + - dest: userId + src: id + operationId: assignRoleToUser + - alias: getRole + arguments: + - dest: userId + src: id + operationId: getUserRole + - alias: removeRole + arguments: + - dest: userId + src: id + operationId: removeRoleFromUser + - alias: listGroupTargets + arguments: + - dest: userId + src: id + operationId: listGroupTargetsForRole + - alias: removeGroupTarget + arguments: + - dest: userId + src: id + operationId: removeGroupTargetFromRole + - alias: addGroupTarget + arguments: + - dest: userId + src: id + operationId: addGroupTargetToRole + - alias: listAssignedRoles + arguments: + - dest: userId + src: id + operationId: listAssignedRolesForUser + - alias: addAllAppsAsTarget + arguments: + - dest: userId + src: id + operationId: addAllAppsAsTargetToRole + - alias: listGroups + arguments: + - dest: userId + src: id + operationId: listUserGroups + - alias: listGrants + arguments: + - dest: userId + src: id + operationId: listUserGrants + - alias: revokeGrants + arguments: + - dest: userId + src: id + operationId: revokeUserGrants + - alias: revokeGrant + arguments: + - dest: userId + src: id + operationId: revokeUserGrant + - alias: revokeGrantsForUserAndClient + arguments: + - dest: userId + src: id + operationId: revokeGrantsForUserAndClient + - alias: listRefreshTokensForUserAndClient + arguments: + - dest: userId + src: id + operationId: listRefreshTokensForUserAndClient + - alias: revokeTokenForUserAndClient + arguments: + - dest: userId + src: id + operationId: revokeTokenForUserAndClient + - alias: getRefreshTokenForUserAndClient + arguments: + - dest: userId + src: id + operationId: getRefreshTokenForUserAndClient + - alias: revokeTokensForUserAndClient + arguments: + - dest: userId + src: id + operationId: revokeTokensForUserAndClient + - alias: listClients + arguments: + - dest: userId + src: id + operationId: listUserClients + - alias: activate + arguments: + - dest: userId + src: id + operationId: activateUser + - alias: reactivate + arguments: + - dest: userId + src: id + operationId: reactivateUser + - alias: deactivate + arguments: + - dest: userId + src: id + operationId: deactivateUser + - alias: suspend + arguments: + - dest: userId + src: id + operationId: suspendUser + - alias: unsuspend + arguments: + - dest: userId + src: id + operationId: unsuspendUser + - alias: resetPassword + arguments: + - dest: userId + src: id + operationId: resetPassword + - alias: expirePassword + arguments: + - dest: userId + src: id + operationId: expirePassword + - alias: expirePasswordAndGetTemporaryPassword + arguments: + - dest: userId + src: id + operationId: expirePasswordAndGetTemporaryPassword + - alias: unlock + arguments: + - dest: userId + src: id + operationId: unlockUser + - alias: resetFactors + arguments: + - dest: userId + src: id + operationId: resetFactors + - alias: deleteFactor + arguments: + - dest: userId + src: id + operationId: deleteFactor + - alias: addToGroup + arguments: + - dest: userId + src: id + description: Adds a user to a group with 'OKTA_GROUP' type + operationId: addUserToGroup + - alias: enrollFactor + arguments: + - dest: userId + src: id + operationId: enrollFactor + - alias: listSupportedFactors + arguments: + - dest: userId + src: id + operationId: listSupportedFactors + - alias: listFactors + arguments: + - dest: userId + src: id + operationId: listFactors + - alias: listSupportedSecurityQuestions + arguments: + - dest: userId + src: id + operationId: listSupportedSecurityQuestions + - alias: getFactor + arguments: + - dest: userId + src: id + operationId: getFactor + - alias: setLinkedObject + arguments: + - dest: associatedUserId + src: id + operationId: setLinkedObjectForUser + - alias: listIdentityProviders + arguments: + - dest: userId + src: id + operationId: listUserIdentityProviders + - alias: getLinkedObjects + arguments: + - dest: userId + src: id + operationId: getLinkedObjectsForUser + - alias: clearSessions + arguments: + - dest: userId + src: id + operationId: clearUserSessions + - alias: removeLinkedObject + arguments: + - dest: userId + src: id + operationId: removeLinkedObjectForUser + x-okta-tags: + - User + UserActivationToken: + properties: + activationToken: + readOnly: true + type: string + activationUrl: + readOnly: true + type: string + type: object + x-okta-tags: + - User + UserCondition: + properties: + exclude: + items: + type: string + type: array + include: + items: + type: string + type: array + type: object + x-okta-tags: + - Policy + UserCredentials: + properties: + password: + $ref: '#/components/schemas/PasswordCredential' + provider: + $ref: '#/components/schemas/AuthenticationProvider' + recovery_question: + $ref: '#/components/schemas/RecoveryQuestionCredential' + type: object + x-okta-tags: + - User + UserIdentifierConditionEvaluatorPattern: + properties: + matchType: + enum: + - SUFFIX + - EXPRESSION + - STARTS_WITH + - EQUALS + - CONTAINS + type: string + value: + type: string + type: object + x-okta-tags: + - Policy + UserIdentifierPolicyRuleCondition: + properties: + attribute: + type: string + patterns: + items: + $ref: '#/components/schemas/UserIdentifierConditionEvaluatorPattern' + type: array + type: + enum: + - IDENTIFIER + - ATTRIBUTE + type: string + type: object + x-okta-tags: + - Policy + UserLifecycleAttributePolicyRuleCondition: + properties: + attributeName: + type: string + matchingValue: + type: string + type: object + x-okta-tags: + - Policy + UserNextLogin: + enum: + - changePassword + type: string + x-okta-tags: + - User + UserPolicyRuleCondition: + properties: + exclude: + items: + type: string + type: array + inactivity: + $ref: '#/components/schemas/InactivityPolicyRuleCondition' + include: + items: + type: string + type: array + lifecycleExpiration: + $ref: '#/components/schemas/LifecycleExpirationPolicyRuleCondition' + passwordExpiration: + $ref: '#/components/schemas/PasswordExpirationPolicyRuleCondition' + userLifecycleAttribute: + $ref: '#/components/schemas/UserLifecycleAttributePolicyRuleCondition' + type: object + x-okta-tags: + - Policy + UserProfile: + properties: + city: + type: string + costCenter: + type: string + countryCode: + type: string + department: + type: string + displayName: + type: string + division: + type: string + email: + type: string + employeeNumber: + type: string + firstName: + type: string + honorificPrefix: + type: string + honorificSuffix: + type: string + lastName: + type: string + locale: + type: string + login: + type: string + manager: + type: string + managerId: + type: string + middleName: + type: string + mobilePhone: + type: string + nickName: + type: string + organization: + type: string + postalAddress: + type: string + preferredLanguage: + type: string + primaryPhone: + type: string + profileUrl: + type: string + secondEmail: + type: string + state: + type: string + streetAddress: + type: string + timezone: + type: string + title: + type: string + userType: + type: string + zipCode: + type: string + type: object + x-okta-extensible: true + x-okta-tags: + - User + UserStatus: + enum: + - ACTIVE + - DEPROVISIONED + - LOCKED_OUT + - PASSWORD_EXPIRED + - PROVISIONED + - RECOVERY + - STAGED + - SUSPENDED + type: string + x-okta-tags: + - User + UserStatusPolicyRuleCondition: + properties: + value: + enum: + - ACTIVE + - INACTIVE + - PENDING + - DELETED + - EXPIRED_PASSWORD + - ACTIVATING + - SUSPENDED + - DELETING + type: string + type: object + x-okta-tags: + - Policy + UserType: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + createdBy: + readOnly: true + type: string + default: + readOnly: true + type: boolean + description: + type: string + displayName: + type: string + id: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + lastUpdatedBy: + readOnly: true + type: string + name: + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: userType + self: true + operationId: createUserType + - alias: update + arguments: + - dest: typeId + src: id + - dest: userType + self: true + operationId: updateUserType + - alias: read + arguments: + - dest: typeId + src: id + operationId: getUserType + - alias: delete + arguments: + - dest: typeId + src: id + operationId: deleteUserType + x-okta-operations: + - alias: replaceUserType + arguments: + - dest: roleId + src: id + operationId: replaceUserType + x-okta-tags: + - UserType + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + appadmintargets: + id: okta.user.appadmintargets + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} + response: + openAPIDocKey: '204' + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} + response: + openAPIDocKey: '204' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps + response: + mediaType: application/json + openAPIDocKey: '200' + name: appadmintargets + title: appadmintargets + appadmintargetsall: + id: okta.user.appadmintargetsall + methods: + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps + response: + openAPIDocKey: '200' + name: appadmintargetsall + title: appadmintargetsall + appinstanceadmintargets: + id: okta.user.appinstanceadmintargets + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} + response: + openAPIDocKey: '204' + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} + response: + openAPIDocKey: '204' + name: appinstanceadmintargets + title: appinstanceadmintargets + applinks: + id: okta.user.applinks + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/appLinks + response: + mediaType: application/json + openAPIDocKey: '200' + name: applinks + title: applinks + clientgrants: + id: okta.user.clientgrants + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/clients/{clientId}/grants + response: + openAPIDocKey: '204' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/clients/{clientId}/grants + response: + mediaType: application/json + openAPIDocKey: '200' + name: clientgrants + title: clientgrants + clients: + id: okta.user.clients + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/clients + response: + mediaType: application/json + openAPIDocKey: '200' + name: clients + title: clients + clienttokens: + id: okta.user.clienttokens + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId} + response: + openAPIDocKey: '204' + deleteAll: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/clients/{clientId}/tokens + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/clients/{clientId}/tokens + response: + mediaType: application/json + openAPIDocKey: '200' + name: clienttokens + title: clienttokens + grants: + id: okta.user.grants + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/grants/{grantId} + response: + openAPIDocKey: '204' + deleteAll: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/grants + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/grants/{grantId} + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/grants + response: + mediaType: application/json + openAPIDocKey: '200' + name: grants + title: grants + grouptargets: + id: okta.user.grouptargets + methods: + delete: + operation: + $ref: PUT + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId} + response: + openAPIDocKey: '200' + insert: + operation: + $ref: PUT + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId} + response: + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/roles/{roleId}/targets/groups + response: + mediaType: application/json + openAPIDocKey: '200' + name: grouptargets + title: grouptargets + idps: + id: okta.user.idps + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/idps + response: + mediaType: application/json + openAPIDocKey: '200' + name: idps + title: idps + linkedobject: + id: okta.user.linkedobject + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/linkedObjects/{relationshipName} + response: + openAPIDocKey: '204' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/linkedObjects/{relationshipName} + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId} + response: + openAPIDocKey: '204' + name: linkedobject + title: linkedobject + roles: + id: okta.user.roles + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/roles/{roleId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/roles/{roleId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/roles + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '201' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/roles + response: + mediaType: application/json + openAPIDocKey: '200' + name: roles + title: roles + sessions: + id: okta.user.sessions + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/sessions + response: + openAPIDocKey: '204' + name: sessions + title: sessions + users: + id: okta.user.users + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/activate + response: + mediaType: application/json + openAPIDocKey: '200' + changePassword: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/credentials/change_password + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + changeRecoveryQuestion: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/credentials/change_recovery_question + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + deactivate: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/deactivate + response: + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId} + response: + openAPIDocKey: '202' + expirePassword: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/expire_password?tempPassword=false + response: + mediaType: application/json + openAPIDocKey: '200' + expirePasswordTemp: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/expire_password?tempPassword=true + response: + mediaType: application/json + openAPIDocKey: '200' + forgotPassword: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/credentials/forgot_password + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/users + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users + response: + mediaType: application/json + openAPIDocKey: '200' + reactivate: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/reactivate + response: + mediaType: application/json + openAPIDocKey: '200' + resetFactors: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/reset_factors + response: + openAPIDocKey: '200' + resetPassword: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/reset_password + response: + mediaType: application/json + openAPIDocKey: '200' + suspend: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/suspend + response: + openAPIDocKey: '200' + unlock: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/unlock + response: + openAPIDocKey: '200' + unsuspend: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/lifecycle/unsuspend + response: + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/users/{userId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: users + title: users +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/users: + get: + description: Lists users in your organization with pagination in most cases. A + subset of users can be returned that match a supported filter expression or + search criteria. + operationId: listUsers + parameters: + - description: Finds a user that matches firstName, lastName, and email properties + in: query + name: q + schema: + type: string + - description: Specifies the pagination cursor for the next page of users + in: query + name: after + schema: + type: string + - description: Specifies the number of results returned + in: query + name: limit + schema: + default: 10 + format: int32 + type: integer + - description: Filters users with a supported expression for a subset of properties + in: query + name: filter + schema: + type: string + - description: Searches for users with a supported filtering expression for + most properties + in: query + name: search + schema: + type: string + - in: query + name: sortBy + schema: + type: string + - in: query + name: sortOrder + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/User' + type: array + description: Success + security: + - api_token: [] + summary: List Users + tags: + - User + post: + description: Creates a new user in your Okta organization with or without credentials. + operationId: createUser + parameters: + - description: Executes activation lifecycle operation when creating the user + in: query + name: activate + schema: + default: true + type: boolean + - description: Indicates whether to create a user with a specified authentication + provider + in: query + name: provider + schema: + default: false + type: boolean + - description: With activate=true, set nextLogin to "changePassword" to have + the password be EXPIRED, so user must change it the next time they log in. + in: query + name: nextLogin + schema: + type: string + x-okta-added-version: 0.14.0 + x-openapi-v3-schema-ref: '#/components/schemas/UserNextLogin' + x-okta-added-version: 0.14.0 + x-openapi-v3-schema-ref: '#/components/schemas/UserNextLogin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUserRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Success + security: + - api_token: [] + summary: Create User + tags: + - User + x-codegen-request-body-name: body + /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}: + put: + operationId: setLinkedObjectForUser + parameters: + - in: path + name: associatedUserId + required: true + schema: + type: string + - in: path + name: primaryRelationshipName + required: true + schema: + type: string + - in: path + name: primaryUserId + required: true + schema: + type: string + responses: + '204': + content: {} + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}: + delete: + description: Deletes a user permanently. This operation can only be performed + on users that have a `DEPROVISIONED` status. **This action cannot be recovered!** + operationId: deactivateOrDeleteUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: sendEmail + schema: + default: false + type: boolean + x-okta-added-version: 1.5.0 + x-okta-added-version: 1.5.0 + responses: + '202': + content: {} + description: ACCEPTED + security: + - api_token: [] + summary: Delete User + tags: + - User + get: + description: Fetches a user from your Okta organization. + operationId: getUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Success + security: + - api_token: [] + summary: Get User + tags: + - User + post: + description: Fetch a user by `id`, `login`, or `login shortname` if the short + name is unambiguous. + operationId: partialUpdateUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: strict + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Success + security: + - api_token: [] + tags: + - User + x-codegen-request-body-name: user + put: + description: Update a user's profile and/or credentials using strict-update + semantics. + operationId: updateUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: strict + schema: + type: boolean + x-okta-added-version: 1.10.0 + x-okta-added-version: 1.10.0 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Success + security: + - api_token: [] + summary: Update User + tags: + - User + x-codegen-request-body-name: user + /api/v1/users/{userId}/appLinks: + get: + description: Fetches appLinks for all direct or indirect (via group membership) + assigned applications. + operationId: listAppLinks + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AppLink' + type: array + description: Success + security: + - api_token: [] + summary: Get Assigned App Links + tags: + - User + /api/v1/users/{userId}/clients: + get: + description: Lists all client resources for which the specified user has grants + or tokens. + operationId: listUserClients + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2Client' + type: array + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/clients/{clientId}/grants: + delete: + description: Revokes all grants for the specified user and client + operationId: revokeGrantsForUserAndClient + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + get: + description: Lists all grants for a specified user and client + operationId: listGrantsForUserAndClient + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2ScopeConsentGrant' + type: array + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/clients/{clientId}/tokens: + delete: + description: Revokes all refresh tokens issued for the specified User and Client. + operationId: revokeTokensForUserAndClient + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + get: + description: Lists all refresh tokens issued for the specified User and Client. + operationId: listRefreshTokensForUserAndClient + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2RefreshToken' + type: array + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}: + delete: + description: Revokes the specified refresh token. + operationId: revokeTokenForUserAndClient + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + - in: path + name: tokenId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + get: + description: Gets a refresh token issued for the specified User and Client. + operationId: getRefreshTokenForUserAndClient + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: clientId + required: true + schema: + type: string + - in: path + name: tokenId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + - in: query + name: limit + schema: + default: 20 + type: integer + - in: query + name: after + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2RefreshToken' + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/credentials/change_password: + post: + description: Changes a user's password by validating the user's current password. + This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, + or `RECOVERY` status that have a valid password credential + operationId: changePassword + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: strict + schema: + type: boolean + x-okta-added-version: 1.10.0 + x-okta-added-version: 1.10.0 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangePasswordRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserCredentials' + description: Success + security: + - api_token: [] + summary: Change Password + tags: + - User + x-codegen-request-body-name: changePasswordRequest + /api/v1/users/{userId}/credentials/change_recovery_question: + post: + description: Changes a user's recovery question & answer credential by validating + the user's current password. This operation can only be performed on users + in **STAGED**, **ACTIVE** or **RECOVERY** `status` that have a valid password + credential + operationId: changeRecoveryQuestion + parameters: + - in: path + name: userId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserCredentials' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserCredentials' + description: Success + security: + - api_token: [] + summary: Change Recovery Question + tags: + - User + x-codegen-request-body-name: userCredentials + /api/v1/users/{userId}/credentials/forgot_password: + post: + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ForgotPasswordResponse' + description: Success + security: + - api_token: [] + summary: Forgot Password + tags: + - User + x-okta-multi-operation: + - description: Generates a one-time token (OTT) that can be used to reset a + user's password + operationId: forgotPasswordGenerateOneTimeToken + parameters: + - default: true + in: query + name: sendEmail + type: boolean + - description: Sets a new password for a user by validating the user's answer + to their current recovery question + operationId: forgotPasswordSetNewPassword + parameters: + - in: body + name: user + required: true + schema: + $ref: '#/components/schemas/UserCredentials' + - default: true + in: query + name: sendEmail + type: boolean + /api/v1/users/{userId}/grants: + delete: + description: Revokes all grants for a specified user + operationId: revokeUserGrants + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + get: + description: Lists all grants for the specified user + operationId: listUserGrants + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: scopeId + schema: + type: string + - in: query + name: expand + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/OAuth2ScopeConsentGrant' + type: array + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/grants/{grantId}: + delete: + description: Revokes one grant for a specified user + operationId: revokeUserGrant + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: grantId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + get: + description: Gets a grant for the specified user + operationId: getUserGrant + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: grantId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OAuth2ScopeConsentGrant' + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/groups: + get: + description: Fetches the groups of which the user is a member. + operationId: listUserGroups + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Group' + type: array + description: Success + security: + - api_token: [] + summary: Get Member Groups + tags: + - User + /api/v1/users/{userId}/idps: + get: + description: Lists the IdPs associated with the user. + operationId: listUserIdentityProviders + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/IdentityProvider' + type: array + description: Success + security: + - api_token: [] + summary: Listing IdPs associated with a user + tags: + - User + /api/v1/users/{userId}/lifecycle/activate: + post: + description: Activates a user. This operation can only be performed on users + with a `STAGED` status. Activation of a user is an asynchronous operation. + The user will have the `transitioningToStatus` property with a value of `ACTIVE` + during activation to indicate that the user hasn't completed the asynchronous + operation. The user will have a status of `ACTIVE` when the activation process + is complete. + operationId: activateUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - description: Sends an activation email to the user if true + in: query + name: sendEmail + required: true + schema: + default: true + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserActivationToken' + description: Success + security: + - api_token: [] + summary: Activate User + tags: + - User + /api/v1/users/{userId}/lifecycle/deactivate: + post: + description: Deactivates a user. This operation can only be performed on users + that do not have a `DEPROVISIONED` status. Deactivation of a user is an asynchronous + operation. The user will have the `transitioningToStatus` property with a + value of `DEPROVISIONED` during deactivation to indicate that the user hasn't + completed the asynchronous operation. The user will have a status of `DEPROVISIONED` + when the deactivation process is complete. + operationId: deactivateUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: sendEmail + schema: + default: false + type: boolean + x-okta-added-version: 1.5.0 + x-okta-added-version: 1.5.0 + responses: + '200': + content: {} + description: OK + security: + - api_token: [] + summary: Deactivate User + tags: + - User + /api/v1/users/{userId}/lifecycle/expire_password?tempPassword=false: + post: + description: This operation transitions the user to the status of `PASSWORD_EXPIRED` + so that the user is required to change their password at their next login. + operationId: expirePassword + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Success + security: + - api_token: [] + summary: Expire Password + tags: + - User + /api/v1/users/{userId}/lifecycle/expire_password?tempPassword=true: + post: + description: This operation transitions the user to the status of `PASSWORD_EXPIRED` + and the user's password is reset to a temporary password that is returned. + operationId: expirePasswordAndGetTemporaryPassword + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TempPassword' + description: Success + security: + - api_token: [] + summary: Expire Password + tags: + - User + /api/v1/users/{userId}/lifecycle/reactivate: + post: + description: Reactivates a user. This operation can only be performed on users + with a `PROVISIONED` status. This operation restarts the activation workflow + if for some reason the user activation was not completed when using the activationToken + from [Activate User](#activate-user). + operationId: reactivateUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - description: Sends an activation email to the user if true + in: query + name: sendEmail + schema: + default: false + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserActivationToken' + description: Success + security: + - api_token: [] + summary: Reactivate User + tags: + - User + /api/v1/users/{userId}/lifecycle/reset_factors: + post: + description: This operation resets all factors for the specified user. All MFA + factor enrollments returned to the unenrolled state. The user's status remains + ACTIVE. This link is present only if the user is currently enrolled in one + or more MFA factors. + operationId: resetFactors + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: {} + description: OK + security: + - api_token: [] + summary: Reset Factors + tags: + - User + /api/v1/users/{userId}/lifecycle/reset_password: + post: + description: Generates a one-time token (OTT) that can be used to reset a user's + password. The OTT link can be automatically emailed to the user or returned + to the API caller and distributed using a custom flow. + operationId: resetPassword + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: sendEmail + required: true + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ResetPasswordToken' + description: Success + security: + - api_token: [] + summary: Reset Password + tags: + - User + /api/v1/users/{userId}/lifecycle/suspend: + post: + description: Suspends a user. This operation can only be performed on users + with an `ACTIVE` status. The user will have a status of `SUSPENDED` when + the process is complete. + operationId: suspendUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: {} + description: OK + security: + - api_token: [] + summary: Suspend User + tags: + - User + /api/v1/users/{userId}/lifecycle/unlock: + post: + description: Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` + status. Users will be able to login with their current password. + operationId: unlockUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + summary: Unlock User + tags: + - User + /api/v1/users/{userId}/lifecycle/unsuspend: + post: + description: Unsuspends a user and returns them to the `ACTIVE` state. This + operation can only be performed on users that have a `SUSPENDED` status. + operationId: unsuspendUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + summary: Unsuspend User + tags: + - User + /api/v1/users/{userId}/linkedObjects/{relationshipName}: + delete: + description: Delete linked objects for a user, relationshipName can be ONLY + a primary relationship name + operationId: removeLinkedObjectForUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: relationshipName + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + get: + description: Get linked objects for a user, relationshipName can be a primary + or associated relationship name + operationId: getLinkedObjectsForUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: relationshipName + required: true + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: -1 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ResponseLinks' + type: array + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/roles: + get: + description: Lists all roles assigned to a user. + operationId: listAssignedRolesForUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Role' + type: array + description: Success + security: + - api_token: [] + tags: + - User + post: + description: Assigns a role to a user. + operationId: assignRoleToUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: disableNotifications + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AssignRoleRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: Created + security: + - api_token: [] + tags: + - User + x-codegen-request-body-name: assignRoleRequest + /api/v1/users/{userId}/roles/{roleId}: + delete: + description: Unassigns a role from a user. + operationId: removeRoleFromUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + get: + description: Gets role that is assigne to user. + operationId: getUserRole + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps: + get: + description: Lists all App targets for an `APP_ADMIN` Role assigned to a User. + This methods return list may include full Applications or Instances. The response + for an instance will have an `ID` value, while Application will not have an + ID. + operationId: listApplicationTargetsForApplicationAdministratorRoleForUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/CatalogApplication' + type: array + description: Success + security: + - api_token: [] + tags: + - User + put: + description: Success + operationId: addAllAppsAsTargetToRole + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}: + delete: + description: Success + operationId: removeApplicationTargetFromApplicationAdministratorRoleForUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: appName + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + put: + description: Success + operationId: addApplicationTargetToAdminRoleForUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: appName + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}: + delete: + description: Remove App Instance Target to App Administrator Role given to a + User + operationId: removeApplicationTargetFromAdministratorRoleForUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: appName + required: true + schema: + type: string + - in: path + name: applicationId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Remove App Instance Target to App Administrator Role given to a User + tags: + - User + put: + description: Add App Instance Target to App Administrator Role given to a User + operationId: addApplicationTargetToAppAdminRoleForUser + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: appName + required: true + schema: + type: string + - in: path + name: applicationId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + summary: Add App Instance Target to App Administrator Role given to a User + tags: + - User + /api/v1/users/{userId}/roles/{roleId}/targets/groups: + get: + description: Success + operationId: listGroupTargetsForRole + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: query + name: after + schema: + type: string + - in: query + name: limit + schema: + default: 20 + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Group' + type: array + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}: + delete: + description: Success + operationId: removeGroupTargetFromRole + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: groupId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User + put: + description: Success + operationId: addGroupTargetToRole + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: roleId + required: true + schema: + type: string + - in: path + name: groupId + required: true + schema: + type: string + responses: + '200': + content: {} + description: Success + security: + - api_token: [] + tags: + - User + /api/v1/users/{userId}/sessions: + delete: + description: Removes all active identity provider sessions. This forces the + user to authenticate on the next operation. Optionally revokes OpenID Connect + and OAuth refresh and access tokens issued to the user. + operationId: clearUserSessions + parameters: + - in: path + name: userId + required: true + schema: + type: string + - description: Revoke issued OpenID Connect and OAuth refresh and access tokens + in: query + name: oauthTokens + schema: + default: false + type: boolean + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - User +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/User.yaml.sig b/test/registry/src/okta/v1/services/User.yaml.sig new file mode 100644 index 00000000..24ffd667 --- /dev/null +++ b/test/registry/src/okta/v1/services/User.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnLHig2AKUP/kyXe2McIZ3TfzGawuzaZZohBoPw5ZPmQoVwFaDjfGLT7UGOcsZefHVp2mMlVB/NM7+PM/TXXOXJSTe33+gBw== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/UserFactor.yaml b/test/registry/src/okta/v1/services/UserFactor.yaml new file mode 100644 index 00000000..7e13ee01 --- /dev/null +++ b/test/registry/src/okta/v1/services/UserFactor.yaml @@ -0,0 +1,851 @@ +components: + schemas: + ActivateFactorRequest: + properties: + attestation: + type: string + clientData: + type: string + passCode: + type: string + registrationData: + type: string + stateToken: + type: string + type: object + x-okta-tags: + - UserFactor + CallUserFactor: + properties: + profile: + $ref: '#/components/schemas/CallUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + CallUserFactorProfile: + properties: + phoneExtension: + type: string + phoneNumber: + type: string + type: object + x-okta-tags: + - UserFactor + CustomHotpUserFactor: + properties: + factorProfileId: + type: string + profile: + $ref: '#/components/schemas/CustomHotpUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + CustomHotpUserFactorProfile: + properties: + sharedSecret: + type: string + type: object + x-okta-tags: + - UserFactor + EmailUserFactor: + properties: + profile: + $ref: '#/components/schemas/EmailUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + EmailUserFactorProfile: + properties: + email: + type: string + type: object + x-okta-tags: + - UserFactor + FactorProvider: + enum: + - OKTA + - RSA + - FIDO + - GOOGLE + - SYMANTEC + - DUO + - YUBICO + - CUSTOM + type: string + x-okta-tags: + - UserFactor + FactorResultType: + enum: + - SUCCESS + - CHALLENGE + - WAITING + - FAILED + - REJECTED + - TIMEOUT + - TIME_WINDOW_EXCEEDED + - PASSCODE_REPLAYED + - ERROR + - CANCELLED + type: string + x-okta-tags: + - UserFactor + FactorStatus: + enum: + - PENDING_ACTIVATION + - ACTIVE + - INACTIVE + - NOT_SETUP + - ENROLLED + - DISABLED + - EXPIRED + type: string + x-okta-tags: + - UserFactor + FactorType: + enum: + - call + - email + - hotp + - push + - question + - sms + - token:hardware + - token:hotp + - token:software:totp + - token + - u2f + - web + - webauthn + type: string + x-okta-tags: + - UserFactor + HardwareUserFactor: + properties: + profile: + $ref: '#/components/schemas/HardwareUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + HardwareUserFactorProfile: + properties: + credentialId: + type: string + type: object + x-okta-tags: + - UserFactor + PushUserFactor: + properties: + expiresAt: + format: date-time + type: string + factorResult: + $ref: '#/components/schemas/FactorResultType' + profile: + $ref: '#/components/schemas/PushUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + PushUserFactorProfile: + properties: + credentialId: + type: string + deviceToken: + type: string + deviceType: + type: string + name: + type: string + platform: + type: string + version: + type: string + type: object + x-okta-tags: + - UserFactor + SecurityQuestion: + properties: + answer: + type: string + question: + type: string + questionText: + type: string + type: object + x-okta-tags: + - UserFactor + SecurityQuestionUserFactor: + properties: + profile: + $ref: '#/components/schemas/SecurityQuestionUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + SecurityQuestionUserFactorProfile: + properties: + answer: + type: string + question: + type: string + questionText: + type: string + type: object + x-okta-tags: + - UserFactor + SmsUserFactor: + properties: + profile: + $ref: '#/components/schemas/SmsUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + SmsUserFactorProfile: + properties: + phoneNumber: + type: string + type: object + x-okta-tags: + - UserFactor + TokenUserFactor: + properties: + profile: + $ref: '#/components/schemas/TokenUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + TokenUserFactorProfile: + properties: + credentialId: + type: string + type: object + x-okta-tags: + - UserFactor + TotpUserFactor: + properties: + profile: + $ref: '#/components/schemas/TotpUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + TotpUserFactorProfile: + properties: + credentialId: + type: string + type: object + x-okta-tags: + - UserFactor + U2fUserFactor: + properties: + profile: + $ref: '#/components/schemas/U2fUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + U2fUserFactorProfile: + properties: + credentialId: + type: string + type: object + x-okta-tags: + - UserFactor + UserFactor: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + factorType: + $ref: '#/components/schemas/FactorType' + id: + readOnly: true + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + provider: + $ref: '#/components/schemas/FactorProvider' + status: + $ref: '#/components/schemas/FactorStatus' + verify: + $ref: '#/components/schemas/VerifyFactorRequest' + type: object + x-okta-crud: + - alias: delete + arguments: + - dest: factorId + src: id + - dest: userId + parentSrc: id + operationId: deleteFactor + x-okta-operations: + - alias: activate + arguments: + - dest: factorId + src: id + - dest: userId + parentSrc: id + operationId: activateFactor + - alias: verify + arguments: + - dest: factorId + src: id + - dest: userId + parentSrc: id + operationId: verifyFactor + x-okta-tags: + - UserFactor + x-openapi-v3-discriminator: + mapping: + call: '#/components/schemas/CallUserFactor' + email: '#/components/schemas/EmailUserFactor' + hotp: '#/components/schemas/CustomHotpUserFactor' + push: '#/components/schemas/PushUserFactor' + question: '#/components/schemas/SecurityQuestionUserFactor' + sms: '#/components/schemas/SmsUserFactor' + token: '#/components/schemas/TokenUserFactor' + token:hardware: '#/components/schemas/HardwareUserFactor' + token:hotp: '#/components/schemas/CustomHotpUserFactor' + token:software:totp: '#/components/schemas/TotpUserFactor' + u2f: '#/components/schemas/U2fUserFactor' + web: '#/components/schemas/WebUserFactor' + webauthn: '#/components/schemas/WebAuthnUserFactor' + propertyName: factorType + VerifyFactorRequest: + properties: + activationToken: + type: string + answer: + type: string + attestation: + type: string + clientData: + type: string + nextPassCode: + type: string + passCode: + type: string + registrationData: + type: string + stateToken: + type: string + type: object + x-okta-tags: + - UserFactor + VerifyUserFactorResponse: + properties: + _embedded: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + expiresAt: + format: date-time + readOnly: true + type: string + factorResult: + enum: + - SUCCESS + - EXPIRED + - CHALLENGE + - WAITING + - FAILED + - REJECTED + - TIMEOUT + - TIME_WINDOW_EXCEEDED + - PASSCODE_REPLAYED + - ERROR + type: string + factorResultMessage: + type: string + type: object + x-okta-tags: + - UserFactor + WebAuthnUserFactor: + properties: + profile: + $ref: '#/components/schemas/WebAuthnUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + WebAuthnUserFactorProfile: + properties: + authenticatorName: + type: string + credentialId: + type: string + type: object + x-okta-tags: + - UserFactor + WebUserFactor: + properties: + profile: + $ref: '#/components/schemas/WebUserFactorProfile' + type: object + x-okta-parent: '#/components/schemas/UserFactor' + x-okta-tags: + - UserFactor + WebUserFactorProfile: + properties: + credentialId: + type: string + type: object + x-okta-tags: + - UserFactor + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + catalog: + id: okta.userfactor.catalog + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/factors/catalog + response: + mediaType: application/json + openAPIDocKey: '200' + name: catalog + title: catalog + factors: + id: okta.userfactor.factors + methods: + activate: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/users/{userId}/factors/{factorId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/factors/{factorId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/factors + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/factors + response: + mediaType: application/json + openAPIDocKey: '200' + verify: + operation: + $ref: POST + path: + $ref: /api/v1/users/{userId}/factors/{factorId}/verify + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: factors + title: factors + questions: + id: okta.userfactor.questions + methods: + list: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/factors/questions + response: + mediaType: application/json + openAPIDocKey: '200' + name: questions + title: questions + transactions: + id: okta.userfactor.transactions + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId} + response: + mediaType: application/json + openAPIDocKey: '200' + name: transactions + title: transactions +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/users/{userId}/factors: + get: + description: Enumerates all the enrolled factors for the specified user + operationId: listFactors + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/UserFactor' + type: array + description: Success + security: + - api_token: [] + tags: + - UserFactor + post: + description: Enrolls a user with a supported factor. + operationId: enrollFactor + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: query + name: updatePhone + schema: + default: false + type: boolean + - description: id of SMS template (only for SMS factor) + in: query + name: templateId + schema: + type: string + - in: query + name: tokenLifetimeSeconds + schema: + default: 300 + format: int32 + type: integer + x-okta-added-version: 1.3.0 + x-okta-added-version: 1.3.0 + - in: query + name: activate + schema: + default: false + type: boolean + x-okta-added-version: 1.3.0 + x-okta-added-version: 1.3.0 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserFactor' + description: Factor + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserFactor' + description: Success + security: + - api_token: [] + summary: Enroll Factor + tags: + - UserFactor + x-codegen-request-body-name: body + /api/v1/users/{userId}/factors/catalog: + get: + description: Enumerates all the supported factors that can be enrolled for the + specified user + operationId: listSupportedFactors + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/UserFactor' + type: array + description: Success + security: + - api_token: [] + tags: + - UserFactor + /api/v1/users/{userId}/factors/questions: + get: + description: Enumerates all available security questions for a user's `question` + factor + operationId: listSupportedSecurityQuestions + parameters: + - in: path + name: userId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SecurityQuestion' + type: array + description: Success + security: + - api_token: [] + tags: + - UserFactor + /api/v1/users/{userId}/factors/{factorId}: + delete: + description: Unenrolls an existing factor for the specified user, allowing the + user to enroll a new factor. + operationId: deleteFactor + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: factorId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - UserFactor + get: + description: Fetches a factor for the specified user + operationId: getFactor + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: factorId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserFactor' + description: Success + security: + - api_token: [] + tags: + - UserFactor + /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate: + post: + description: The `sms` and `token:software:totp` factor types require activation + to complete the enrollment process. + operationId: activateFactor + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: factorId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ActivateFactorRequest' + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserFactor' + description: Success + security: + - api_token: [] + summary: Activate Factor + tags: + - UserFactor + x-codegen-request-body-name: body + /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}: + get: + description: Polls factors verification transaction for status. + operationId: getFactorTransactionStatus + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: factorId + required: true + schema: + type: string + - in: path + name: transactionId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyUserFactorResponse' + description: Success + security: + - api_token: [] + tags: + - UserFactor + /api/v1/users/{userId}/factors/{factorId}/verify: + post: + description: Verifies an OTP for a `token` or `token:hardware` factor + operationId: verifyFactor + parameters: + - in: path + name: userId + required: true + schema: + type: string + - in: path + name: factorId + required: true + schema: + type: string + - in: query + name: templateId + schema: + type: string + - in: query + name: tokenLifetimeSeconds + schema: + default: 300 + format: int32 + type: integer + x-okta-added-version: 1.3.0 + x-okta-added-version: 1.3.0 + - in: header + name: X-Forwarded-For + schema: + type: string + x-okta-added-version: 1.11.0 + x-okta-added-version: 1.11.0 + - in: header + name: User-Agent + schema: + type: string + x-okta-added-version: 1.11.0 + x-okta-added-version: 1.11.0 + - in: header + name: Accept-Language + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyFactorRequest' + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyUserFactorResponse' + description: Success + security: + - api_token: [] + summary: Verify MFA Factor + tags: + - UserFactor + x-codegen-request-body-name: body +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/UserFactor.yaml.sig b/test/registry/src/okta/v1/services/UserFactor.yaml.sig new file mode 100644 index 00000000..889962a2 --- /dev/null +++ b/test/registry/src/okta/v1/services/UserFactor.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnC+GI0AKULq/YLH/vVLfpifURM49uv6HvBegZVgc45H/TnE5MvKDg8JkSCe/gLX7NZpjYiSl1kUbW/1xiQrYn+JKKGffVBw== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/UserSchema.yaml b/test/registry/src/okta/v1/services/UserSchema.yaml new file mode 100644 index 00000000..e0879372 --- /dev/null +++ b/test/registry/src/okta/v1/services/UserSchema.yaml @@ -0,0 +1,478 @@ +components: + schemas: + UserSchema: + properties: + $schema: + readOnly: true + type: string + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + readOnly: true + type: string + definitions: + $ref: '#/components/schemas/UserSchemaDefinitions' + id: + readOnly: true + type: string + lastUpdated: + readOnly: true + type: string + name: + readOnly: true + type: string + properties: + $ref: '#/components/schemas/UserSchemaProperties' + title: + type: string + type: + readOnly: true + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttribute: + properties: + description: + type: string + enum: + items: + type: string + type: array + externalName: + type: string + externalNamespace: + type: string + items: + $ref: '#/components/schemas/UserSchemaAttributeItems' + master: + $ref: '#/components/schemas/UserSchemaAttributeMaster' + maxLength: + type: integer + minLength: + type: integer + mutability: + type: string + oneOf: + items: + $ref: '#/components/schemas/UserSchemaAttributeEnum' + type: array + pattern: + type: string + permissions: + items: + $ref: '#/components/schemas/UserSchemaAttributePermission' + type: array + required: + type: boolean + scope: + $ref: '#/components/schemas/UserSchemaAttributeScope' + title: + type: string + type: + $ref: '#/components/schemas/UserSchemaAttributeType' + union: + $ref: '#/components/schemas/UserSchemaAttributeUnion' + unique: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeEnum: + properties: + const: + type: string + title: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeItems: + properties: + enum: + items: + type: string + type: array + oneOf: + items: + $ref: '#/components/schemas/UserSchemaAttributeEnum' + type: array + type: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeMaster: + properties: + priority: + items: + $ref: '#/components/schemas/UserSchemaAttributeMasterPriority' + type: array + type: + $ref: '#/components/schemas/UserSchemaAttributeMasterType' + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeMasterPriority: + properties: + type: + type: string + value: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeMasterType: + enum: + - PROFILE_MASTER + - OKTA + - OVERRIDE + type: string + x-okta-tags: + - UserSchema + UserSchemaAttributePermission: + properties: + action: + type: string + principal: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeScope: + enum: + - SELF + - NONE + type: object + x-okta-tags: + - UserSchema + UserSchemaAttributeType: + enum: + - string + - boolean + - number + - integer + - array + type: string + x-okta-tags: + - UserSchema + UserSchemaAttributeUnion: + enum: + - DISABLE + - ENABLE + type: object + x-okta-tags: + - UserSchema + UserSchemaBase: + properties: + id: + readOnly: true + type: string + properties: + $ref: '#/components/schemas/UserSchemaBaseProperties' + required: + items: + type: string + type: array + type: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaBaseProperties: + properties: + city: + $ref: '#/components/schemas/UserSchemaAttribute' + costCenter: + $ref: '#/components/schemas/UserSchemaAttribute' + countryCode: + $ref: '#/components/schemas/UserSchemaAttribute' + department: + $ref: '#/components/schemas/UserSchemaAttribute' + displayName: + $ref: '#/components/schemas/UserSchemaAttribute' + division: + $ref: '#/components/schemas/UserSchemaAttribute' + email: + $ref: '#/components/schemas/UserSchemaAttribute' + employeeNumber: + $ref: '#/components/schemas/UserSchemaAttribute' + firstName: + $ref: '#/components/schemas/UserSchemaAttribute' + honorificPrefix: + $ref: '#/components/schemas/UserSchemaAttribute' + honorificSuffix: + $ref: '#/components/schemas/UserSchemaAttribute' + lastName: + $ref: '#/components/schemas/UserSchemaAttribute' + locale: + $ref: '#/components/schemas/UserSchemaAttribute' + login: + $ref: '#/components/schemas/UserSchemaAttribute' + manager: + $ref: '#/components/schemas/UserSchemaAttribute' + managerId: + $ref: '#/components/schemas/UserSchemaAttribute' + middleName: + $ref: '#/components/schemas/UserSchemaAttribute' + mobilePhone: + $ref: '#/components/schemas/UserSchemaAttribute' + nickName: + $ref: '#/components/schemas/UserSchemaAttribute' + organization: + $ref: '#/components/schemas/UserSchemaAttribute' + postalAddress: + $ref: '#/components/schemas/UserSchemaAttribute' + preferredLanguage: + $ref: '#/components/schemas/UserSchemaAttribute' + primaryPhone: + $ref: '#/components/schemas/UserSchemaAttribute' + profileUrl: + $ref: '#/components/schemas/UserSchemaAttribute' + secondEmail: + $ref: '#/components/schemas/UserSchemaAttribute' + state: + $ref: '#/components/schemas/UserSchemaAttribute' + streetAddress: + $ref: '#/components/schemas/UserSchemaAttribute' + timezone: + $ref: '#/components/schemas/UserSchemaAttribute' + title: + $ref: '#/components/schemas/UserSchemaAttribute' + userType: + $ref: '#/components/schemas/UserSchemaAttribute' + zipCode: + $ref: '#/components/schemas/UserSchemaAttribute' + type: object + x-okta-tags: + - UserSchema + UserSchemaDefinitions: + properties: + base: + $ref: '#/components/schemas/UserSchemaBase' + custom: + $ref: '#/components/schemas/UserSchemaPublic' + type: object + x-okta-tags: + - UserSchema + UserSchemaProperties: + properties: + profile: + $ref: '#/components/schemas/UserSchemaPropertiesProfile' + type: object + x-okta-tags: + - UserSchema + UserSchemaPropertiesProfile: + properties: + allOf: + items: + $ref: '#/components/schemas/UserSchemaPropertiesProfileItem' + type: array + type: object + x-okta-tags: + - UserSchema + UserSchemaPropertiesProfileItem: + properties: + $ref: + type: string + type: object + x-okta-tags: + - UserSchema + UserSchemaPublic: + properties: + id: + readOnly: true + type: string + properties: + additionalProperties: + $ref: '#/components/schemas/UserSchemaAttribute' + type: object + required: + items: + type: string + type: array + type: + type: string + type: object + x-okta-tags: + - UserSchema + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + default: + id: okta.userschema.default + methods: + insert: + operation: + $ref: POST + path: + $ref: /api/v1/meta/schemas/apps/{appInstanceId}/default + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/meta/schemas/apps/{appInstanceId}/default + response: + mediaType: application/json + openAPIDocKey: '200' + name: default + title: default + schemas: + id: okta.userschema.schemas + methods: + get: + operation: + $ref: GET + path: + $ref: /api/v1/meta/schemas/user/{schemaId} + response: + mediaType: application/json + openAPIDocKey: '200' + partialUpdate: + operation: + $ref: POST + path: + $ref: /api/v1/meta/schemas/user/{schemaId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: schemas + title: schemas +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/meta/schemas/apps/{appInstanceId}/default: + get: + description: Fetches the Schema for an App User + operationId: getApplicationUserSchema + parameters: + - in: path + name: appInstanceId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserSchema' + description: successful operation + security: + - api_token: [] + summary: Fetches the Schema for an App User + tags: + - UserSchema + post: + description: Partial updates on the User Profile properties of the Application + User Schema. + operationId: updateApplicationUserProfile + parameters: + - in: path + name: appInstanceId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserSchema' + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserSchema' + description: successful operation + security: + - api_token: [] + summary: Partial updates on the User Profile properties of the Application User + Schema. + tags: + - UserSchema + x-codegen-request-body-name: body + /api/v1/meta/schemas/user/{schemaId}: + get: + description: Fetches the schema for a Schema Id. + operationId: getUserSchema + parameters: + - in: path + name: schemaId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserSchema' + description: Success + security: + - api_token: [] + summary: Fetches the schema for a Schema Id. + tags: + - UserSchema + post: + description: Partial updates on the User Profile properties of the user schema. + operationId: updateUserProfile + parameters: + - in: path + name: schemaId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserSchema' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserSchema' + description: Success + security: + - api_token: [] + tags: + - UserSchema + x-codegen-request-body-name: userSchema +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/UserSchema.yaml.sig b/test/registry/src/okta/v1/services/UserSchema.yaml.sig new file mode 100644 index 00000000..13824bb6 --- /dev/null +++ b/test/registry/src/okta/v1/services/UserSchema.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELnABiNKAKUUi25DZ8445kmcCakiVS6+wFsZvah2P5cUVs7Ab8rGESFlJkmCKejcW47GHCw5RxrJaHX2WfWuY3ncK2nxb28DA== \ No newline at end of file diff --git a/test/registry/src/okta/v1/services/UserType.yaml b/test/registry/src/okta/v1/services/UserType.yaml new file mode 100644 index 00000000..bb1a6b3f --- /dev/null +++ b/test/registry/src/okta/v1/services/UserType.yaml @@ -0,0 +1,288 @@ +components: + schemas: + UserType: + properties: + _links: + additionalProperties: + properties: {} + type: object + readOnly: true + type: object + created: + format: date-time + readOnly: true + type: string + createdBy: + readOnly: true + type: string + default: + readOnly: true + type: boolean + description: + type: string + displayName: + type: string + id: + type: string + lastUpdated: + format: date-time + readOnly: true + type: string + lastUpdatedBy: + readOnly: true + type: string + name: + type: string + type: object + x-okta-crud: + - alias: create + arguments: + - dest: userType + self: true + operationId: createUserType + - alias: update + arguments: + - dest: typeId + src: id + - dest: userType + self: true + operationId: updateUserType + - alias: read + arguments: + - dest: typeId + src: id + operationId: getUserType + - alias: delete + arguments: + - dest: typeId + src: id + operationId: deleteUserType + x-okta-operations: + - alias: replaceUserType + arguments: + - dest: roleId + src: id + operationId: replaceUserType + x-okta-tags: + - UserType + securitySchemes: + api_token: + description: SSWS {API Token} + in: header + name: Authorization + type: apiKey + x-stackQL-resources: + user: + id: okta.usertype.user + methods: + delete: + operation: + $ref: DELETE + path: + $ref: /api/v1/meta/types/user/{typeId} + response: + openAPIDocKey: '204' + get: + operation: + $ref: GET + path: + $ref: /api/v1/meta/types/user/{typeId} + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: POST + path: + $ref: /api/v1/meta/types/user + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: GET + path: + $ref: /api/v1/meta/types/user + response: + mediaType: application/json + openAPIDocKey: '200' + partialUpdate: + operation: + $ref: POST + path: + $ref: /api/v1/meta/types/user/{typeId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: PUT + path: + $ref: /api/v1/meta/types/user/{typeId} + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + name: user + title: user +externalDocs: + description: Find more info here + url: https://developer.okta.com/docs/api/getting_started/design_principles.html +info: + contact: + email: devex-public@okta.com + name: Okta Developer Team + url: https://developer.okta.com/ + description: Allows customers to easily access the Okta API + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://developer.okta.com/terms/ + title: Okta API + version: 2.8.0 +openapi: 3.0.1 +paths: + /api/v1/meta/types/user: + get: + description: Fetches all User Types in your org + operationId: listUserTypes + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/UserType' + type: array + description: Success + security: + - api_token: [] + tags: + - UserType + post: + description: Creates a new User Type. A default User Type is automatically created + along with your org, and you may add another 9 User Types for a maximum of + 10. + operationId: createUserType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserType' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserType' + description: Success + security: + - api_token: [] + tags: + - UserType + x-codegen-request-body-name: userType + /api/v1/meta/types/user/{typeId}: + delete: + description: Deletes a User Type permanently. This operation is not permitted + for the default type, nor for any User Type that has existing users + operationId: deleteUserType + parameters: + - in: path + name: typeId + required: true + schema: + type: string + responses: + '204': + content: {} + description: No Content + security: + - api_token: [] + tags: + - UserType + get: + description: Fetches a User Type by ID. The special identifier `default` may + be used to fetch the default User Type. + operationId: getUserType + parameters: + - in: path + name: typeId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserType' + description: Success + security: + - api_token: [] + tags: + - UserType + post: + description: Updates an existing User Type + operationId: updateUserType + parameters: + - in: path + name: typeId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserType' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserType' + description: Success + security: + - api_token: [] + tags: + - UserType + x-codegen-request-body-name: userType + put: + description: Replace an existing User Type + operationId: replaceUserType + parameters: + - in: path + name: typeId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserType' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserType' + description: Success + security: + - api_token: [] + tags: + - UserType + x-codegen-request-body-name: userType +servers: +- url: https://{subdomain}.okta.com/ + variables: + subdomain: + default: my-domain diff --git a/test/registry/src/okta/v1/services/UserType.yaml.sig b/test/registry/src/okta/v1/services/UserType.yaml.sig new file mode 100644 index 00000000..c588f456 --- /dev/null +++ b/test/registry/src/okta/v1/services/UserType.yaml.sig @@ -0,0 +1 @@ +AQAAAA7ZnELmOWXwcAKU65JtZKd7zgAOeikTG5NNDLtUfYdLu1XpToqRVoMH5ASF9SztzczPbinRa1jDuueEfsKAuxv3kYfY+XgeEQVIBA== \ No newline at end of file diff --git a/test/server/README.md b/test/server/README.md new file mode 100644 index 00000000..49302906 --- /dev/null +++ b/test/server/README.md @@ -0,0 +1,32 @@ + + +# HTTPS server for simulated integration / regression testing + +## Mock Server + +We are using the java [mockserver](https://www.mock-server.com/) tool. + +To install: + +```bash +mvn org.apache.maven.plugins:maven-dependency-plugin:3.2.0:copy -Dartifact=org.mock-server:mockserver-netty:5.12.0:jar:shaded -DoutputDirectory=${HOME}/stackql/stackql-devel/test/downloads -DdestFileName=mockserver-netty.jar -DoverWrite=true +``` + +To run: + +```bash +java -Dfile.encoding=UTF-8 -Dmockserver.initializationJsonPath=${HOME}/stackql/stackql-devel/test/server/expectations/static-expectations.json -jar /usr/local/lib/mockserver/mockserver-netty-jar-with-dependencies.jar -serverPort 1080 -logLevel INFO +``` + +### Expectations from local file + +As per [expectations/static-gcp-expectations.json](/test/server/expectations/static-gcp-expectations.json) + + +Basic idea is to rewrite openapi docs and also dummy credentials file such that +all requests go to localhost. We will pass in the dummy server CA to StackQL at init time. +This will obviously only occur in testing. + +``` +"select ipCidrRange, sum(5) cc from google.container.`projects.aggregated.usableSubnetworks` where projectsId = 'testing-project' group by \"ipCidrRange\" having sum(5) >= 5 order by ipCidrRange desc;" +``` \ No newline at end of file diff --git a/test/server/expectations/static-gcp-expectations.json b/test/server/expectations/static-gcp-expectations.json new file mode 100644 index 00000000..8350500c --- /dev/null +++ b/test/server/expectations/static-gcp-expectations.json @@ -0,0 +1,108 @@ +[ + { + "httpRequest": { + "method": "POST", + "path": "/token" + }, + "httpResponse": { + "body": { + "access_token": "some-access-token", + "token_type": "access_token", + "id_token": "eyJhbGciOiJSUzI1NiIsImN0eSI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwiaWF0IjoxNjAzMzc2MDExLCJleHAiOjExNjI4NTY1MzY0LCJhdWQiOiJhdWQteCIsImlzcyI6Imdvb2dsZSIsInNjb3BlIjoiZ29vZ2xlYXBpcyJ9.g_MHGMGbRt0MZaOyKPA7zQNrYRDgabBJwEzUGlCHlWlidWnYSG9mo5YixHwk1AfeDsRTnxxyT9Ki1mSppamKbS_QHj-o54PMLibP6jcQV4aLxwug9cKbzIvQTndWPm41gBT4Bxfip4ZI9DZUtVZ4nv89reDdmZ_WLG_HuDw-3p4E5L_5iIJGGEnfyko8Da1LiHZg6tNGzpmMyjxUhocvUdM5iEHeppkLlGlu9Lw38UVxUCvskKy6WRCnLU7uCZxeoA-Ah8jg-Ie6IPdKm2UvqUflQbfG-Ga7LqzMxSVE_KvRD9_02mYZykjuWQiEAWqMYnBqK4TtoFfAZLTa1cFGvQ", + "expires_in": 3600 + } + } + }, + { + "httpRequest": { + "method": "GET", + "path": "/v1/projects/testing-project/aggregated/usableSubnetworks" + }, + "httpResponse": { + "body": { + "subnetworks": [ + { + "subnetwork": "projects/testing-project/regions/australia-southeast1/subnetworks/sn-02", + "network": "projects/testing-project/global/networks/vpc-01", + "ipCidrRange": "10.0.1.0/24" + }, + { + "subnetwork": "projects/testing-project/regions/australia-southeast1/subnetworks/sn-01", + "network": "projects/testing-project/global/networks/vpc-01", + "ipCidrRange": "10.0.0.0/24" + } + ] + } + } + }, + { + "httpRequest": { + "path": "/v3/organizations/123456789012:getIamPolicy" + }, + "httpResponse": { + "body": { + "version": 1, + "etag": "BwXLxNx6fFw=", + "bindings": [ + { + "role": "roles/billing.admin", + "members": [ + "user:joeblow@myoutfit.com" + ] + }, + { + "role": "roles/compute.networkUser", + "members": [ + "user:joeblow@myoutfit.com" + ] + }, + { + "role": "roles/compute.xpnAdmin", + "members": [ + "user:joeblow@myoutfit.com" + ] + }, + { + "role": "roles/container.clusterAdmin", + "members": [ + "user:joeblow@myoutfit.com" + ] + }, + { + "role": "roles/orgpolicy.policyAdmin", + "members": [ + "user:joeblow@myoutfit.com" + ] + }, + { + "role": "roles/owner", + "members": [ + "user:joeblow@myoutfit.com", + "user:somejimbo@gmail.com" + ] + }, + { + "role": "roles/resourcemanager.folderAdmin", + "members": [ + "user:joeblow@myoutfit.com", + "user:somejimbo@gmail.com" + ] + }, + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:joeblow@myoutfit.com", + "user:somejimbo@gmail.com" + ] + }, + { + "role": "roles/resourcemanager.projectCreator", + "members": [ + "user:joeblow@myoutfit.com" + ] + } + ] + } + } + } +] \ No newline at end of file diff --git a/test/test-generators/always/locally-executable.json b/test/test-generators/always/locally-executable.json index ea792d8e..2b867699 100644 --- a/test/test-generators/always/locally-executable.json +++ b/test/test-generators/always/locally-executable.json @@ -18,7 +18,7 @@ "output": "csv", "delimiter": ";", "instruction": "exec", - "query": "show extended services where description like 'Provides natural language%' and version = 'v1';", + "query": "show extended services from google where description like 'Provides natural language%' and version = 'v1';", "expected": [ "id;name;title;description;version;preferred", "language:v1;.*" @@ -31,7 +31,7 @@ "output": "csv", "delimiter": ";", "instruction": "exec", - "query": "show extended services where description like 'Provides natural language%' and version = 'v1';", + "query": "show extended services from google where description like 'Provides natural language%' and version = 'v1';", "expected": [ "id;name;title;description;version;preferred", "language:v1;.*" @@ -44,7 +44,7 @@ "output": "csv", "delimiter": ";", "instruction": "exec", - "query": "show extended services where description like 'Provides natural language%' and version = 'v1';", + "query": "show extended services from google where description like 'Provides natural language%' and version = 'v1';", "expected": [ "id;name;title;description;version;preferred", "language:v1;.*" @@ -56,7 +56,7 @@ "name": "Tabular stdout based SHOW EXTENDED SERVICES test + assertion", "output": "table", "instruction": "exec", - "query": "show extended services where description like 'Provides natural language%' and version = 'v1';", + "query": "show extended services from google where description like 'Provides natural language%' and version = 'v1';", "expected": [ "\\|[\\|\\-]*\\|$", "\\|[\\W]+id", diff --git a/test/test-generators/live-integration/live-integration.json b/test/test-generators/live-integration/live-integration.json index 165e9391..96f1236a 100644 --- a/test/test-generators/live-integration/live-integration.json +++ b/test/test-generators/live-integration/live-integration.json @@ -7,7 +7,7 @@ "delimiter": ",", "instruction": "exec", "input_file": "input/network-crud/network-crud.iql", - "keyfilepath": "secrets/google/sa-key.json", + "credentialsfilepath": "secrets/google/sa-key.json", "iqldata": "input/live-integration/template-context/local/network-crud/network-crud.jsonnet", "output_file": "output/live-integration-simple-output.txt", "verbose": true,