diff --git a/.vscode/launch.json b/.vscode/launch.json index e321afa1..3f2a480e 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -87,7 +87,7 @@ }, // select name from google.compute.disks where project = 'lab-kr-network-01' and zone = 'australia-southeast1-a'; { - "name": "DEBUG select compute.disks ... ;", + "name": "DEBUG select compute.acceleratorTypes ... ;", "type": "go", "request": "launch", "mode": "debug", @@ -95,9 +95,7 @@ "args": [ "exec", "--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" + "select kind, name from google.compute.acceleratorTypes where project = 'lab-kr-network-01' and zone = 'australia-southeast1-a' order by name desc;" ], }, // show extended resources from okta.group diff --git a/test/assets/expected/simple-select/compute-accelerator-type/select-zone-list-desc.txt b/test/assets/expected/simple-select/compute-accelerator-type/select-zone-list-desc.txt new file mode 100644 index 00000000..28658a57 --- /dev/null +++ b/test/assets/expected/simple-select/compute-accelerator-type/select-zone-list-desc.txt @@ -0,0 +1,11 @@ +|-------------------------|---------------------| +| kind | name | +|-------------------------|---------------------| +| compute#acceleratorType | nvidia-tesla-t4-vws | +|-------------------------|---------------------| +| compute#acceleratorType | nvidia-tesla-t4 | +|-------------------------|---------------------| +| compute#acceleratorType | nvidia-tesla-p4-vws | +|-------------------------|---------------------| +| compute#acceleratorType | nvidia-tesla-p4 | +|-------------------------|---------------------| diff --git a/test/functional/stackql_mocked_from_cmd_line.robot b/test/functional/stackql_mocked_from_cmd_line.robot index a838abbf..78fcad80 100644 --- a/test/functional/stackql_mocked_from_cmd_line.robot +++ b/test/functional/stackql_mocked_from_cmd_line.robot @@ -11,20 +11,36 @@ Suite Teardown Terminate All Processes *** Test Cases *** Google Container Agg Desc Should StackQL Exec Equal + ... ${REGISTRY_NO_VERIFY_CFG_STR} ... ${SELECT_CONTAINER_SUBNET_AGG_DESC} ... ${SELECT_CONTAINER_SUBNET_AGG_DESC_EXPECTED} Google Container Agg Asc Should StackQL Exec Equal + ... ${REGISTRY_NO_VERIFY_CFG_STR} ... ${SELECT_CONTAINER_SUBNET_AGG_ASC} ... ${SELECT_CONTAINER_SUBNET_AGG_ASC_EXPECTED} Google IAM Policy Agg Should StackQL Exec Equal + ... ${REGISTRY_NO_VERIFY_CFG_STR} ... \-\-infile\=${GET_IAM_POLICY_AGG_ASC_INPUT_FILE} ... ${GET_IAM_POLICY_AGG_ASC_EXPECTED} ... \-o\=csv + +Google AcceleratorTypes SQL verb pre changeover + Should StackQL Exec Equal + ... ${REGISTRY_NO_VERIFY_CFG_STR} + ... ${SELECT_ACCELERATOR_TYPES_DESC} + ... ${SELECT_ACCELERATOR_TYPES_DESC_EXPECTED} + +Google AcceleratorTypes SQL verb post changeover + Should StackQL Exec Equal + ... ${REGISTRY_SQL_VERB_CONTRIVED_NO_VERIFY_CFG_STR} + ... ${SELECT_ACCELERATOR_TYPES_DESC} + ... ${SELECT_ACCELERATOR_TYPES_DESC_EXPECTED} + Basic Query mTLS Returns OK Should PG Client Inline Contain ... ${PSQL_MTLS_CONN_STR} @@ -62,11 +78,11 @@ Prepare StackQL Environment Run StackQL Exec Command - [Arguments] ${_EXEC_CMD_STR} @{varargs} + [Arguments] ${_REGISTRY_CFG_STR} ${_EXEC_CMD_STR} @{varargs} Set Environment Variable OKTA_SECRET_KEY ${OKTA_SECRET_STR} ${result} = Run Process ... ${STACKQL_EXE} - ... exec \-\-registry\=${REGISTRY_NO_VERIFY_CFG_STR} + ... exec \-\-registry\=${_REGISTRY_CFG_STR} ... \-\-auth\=${AUTH_CFG_STR} ... \-\-tls.allowInsecure\=true ... ${_EXEC_CMD_STR} @{varargs} @@ -76,8 +92,8 @@ Run StackQL Exec Command Should StackQL Exec Equal - [Arguments] ${_EXEC_CMD_STR} ${_EXEC_CMD_EXPECTED_OUTPUT} @{varargs} - ${result} = Run StackQL Exec Command ${_EXEC_CMD_STR} @{varargs} + [Arguments] ${_REGISTRY_CFG_STR} ${_EXEC_CMD_STR} ${_EXEC_CMD_EXPECTED_OUTPUT} @{varargs} + ${result} = Run StackQL Exec Command ${_REGISTRY_CFG_STR} ${_EXEC_CMD_STR} @{varargs} Should Be Equal ${result.stdout} ${_EXEC_CMD_EXPECTED_OUTPUT} Start StackQL PG Server mTLS diff --git a/test/functional/variables/stackql_context.py b/test/functional/variables/stackql_context.py index a2e687ca..a5a065fd 100644 --- a/test/functional/variables/stackql_context.py +++ b/test/functional/variables/stackql_context.py @@ -31,6 +31,15 @@ def get_unix_path(pathStr :str) -> str: "nopVerify": True } } +_REGISTRY_SQL_VERB_CONTRIVED_NO_VERIFY_CFG = { + "url": f"file://{get_unix_path(REGISTRY_ROOT_CANONICAL)}", + "localDocRoot": f"{get_unix_path(REGISTRY_ROOT_CANONICAL)}", + "srcPrefix": "registry-verb-matching-src", + "useEmbedded": False, + "verifyConfig": { + "nopVerify": True + } +} _REGISTRY_CANONICAL_CFG = { "url": f"file://{get_unix_path(REGISTRY_ROOT_CANONICAL)}", "localDocRoot": f"{get_unix_path(REGISTRY_ROOT_CANONICAL)}", @@ -79,6 +88,7 @@ def get_unix_path(pathStr :str) -> str: OKTA_SECRET_STR = f.read() REGISTRY_NO_VERIFY_CFG_STR = json.dumps(_REGISTRY_NO_VERIFY_CFG) +REGISTRY_SQL_VERB_CONTRIVED_NO_VERIFY_CFG_STR = json.dumps(_REGISTRY_SQL_VERB_CONTRIVED_NO_VERIFY_CFG) REGISTRY_CANONICAL_CFG_STR = json.dumps(_REGISTRY_CANONICAL_CFG) REGISTRY_DEPRECATED_CFG_STR = json.dumps(_REGISTRY_DEPRECATED_CFG) AUTH_CFG_STR = json.dumps(_AUTH_CFG) @@ -104,11 +114,14 @@ def get_unix_path(pathStr :str) -> str: 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_ACCELERATOR_TYPES_DESC = "select kind, name from google.compute.acceleratorTypes where project = 'testing-project' and zone = 'australia-southeast1-a' order by name desc;" 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')) +SELECT_ACCELERATOR_TYPES_DESC_EXPECTED = get_output_from_local_file(os.path.join('test', 'assets', 'expected', 'simple-select', 'compute-accelerator-type', 'select-zone-list-desc.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/mockserver/README.md b/test/mockserver/README.md index 49302906..5a40060a 100644 --- a/test/mockserver/README.md +++ b/test/mockserver/README.md @@ -15,7 +15,7 @@ mvn org.apache.maven.plugins:maven-dependency-plugin:3.2.0:copy -Dartifact=org.m 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 +java -Dfile.encoding=UTF-8 -Dmockserver.initializationJsonPath=${HOME}/stackql/stackql-devel/test/mockserver/expectations/static-gcp-expectations.json -jar /usr/local/lib/mockserver/mockserver-netty-jar-with-dependencies.jar -serverPort 1080 -logLevel INFO ``` ### Expectations from local file diff --git a/test/mockserver/expectations/static-gcp-expectations.json b/test/mockserver/expectations/static-gcp-expectations.json index 8350500c..22271bb1 100644 --- a/test/mockserver/expectations/static-gcp-expectations.json +++ b/test/mockserver/expectations/static-gcp-expectations.json @@ -35,6 +35,61 @@ } } }, + { + "httpRequest": { + "method": "GET", + "path": "/projects/testing-project/zones/australia-southeast1-a/acceleratorTypes" + }, + "httpResponse": { + "body": { + "kind": "compute#acceleratorTypeList", + "id": "projects/testing-project/zones/australia-southeast1-a/acceleratorTypes", + "items": [ + { + "kind": "compute#acceleratorType", + "id": "10010", + "creationTimestamp": "1969-12-31T16:00:00.000-08:00", + "name": "nvidia-tesla-p4", + "description": "NVIDIA Tesla P4", + "zone": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a", + "selfLink": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a/acceleratorTypes/nvidia-tesla-p4", + "maximumCardsPerInstance": 4 + }, + { + "kind": "compute#acceleratorType", + "id": "10012", + "creationTimestamp": "1969-12-31T16:00:00.000-08:00", + "name": "nvidia-tesla-p4-vws", + "description": "NVIDIA Tesla P4 Virtual Workstation", + "zone": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a", + "selfLink": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a/acceleratorTypes/nvidia-tesla-p4-vws", + "maximumCardsPerInstance": 4 + }, + { + "kind": "compute#acceleratorType", + "id": "10019", + "creationTimestamp": "1969-12-31T16:00:00.000-08:00", + "name": "nvidia-tesla-t4", + "description": "NVIDIA Tesla T4", + "zone": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a", + "selfLink": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a/acceleratorTypes/nvidia-tesla-t4", + "maximumCardsPerInstance": 4 + }, + { + "kind": "compute#acceleratorType", + "id": "10020", + "creationTimestamp": "1969-12-31T16:00:00.000-08:00", + "name": "nvidia-tesla-t4-vws", + "description": "NVIDIA Tesla T4 Virtual Workstation", + "zone": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a", + "selfLink": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a/acceleratorTypes/nvidia-tesla-t4-vws", + "maximumCardsPerInstance": 4 + } + ], + "selfLink": "https://www.googleapis.com/compute/beta/projects/testing-project/zones/australia-southeast1-a/acceleratorTypes" + } + } + }, { "httpRequest": { "path": "/v3/organizations/123456789012:getIamPolicy" diff --git a/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/provider.yaml b/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/provider.yaml new file mode 100644 index 00000000..f6fb2905 --- /dev/null +++ b/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/services/compute-v1.yaml + resources: + $ref: googleapis.com/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/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/v2.0.1/services/youtubereporting-v1.yaml + title: YouTube Reporting API + version: v1 +title: google +version: v1 diff --git a/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/resources/compute-v1.yaml b/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/resources/compute-v1.yaml new file mode 100644 index 00000000..86574966 --- /dev/null +++ b/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/resources/compute-v1.yaml @@ -0,0 +1,70 @@ +serviceDoc: + $ref: googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml +resources: + acceleratorTypes: + sqlVerbs: + select: + - $ref: '#/resources/acceleratorTypes/methods/getLost' + - $ref: '#/resources/acceleratorTypes/methods/crazyList' + - $ref: '#/resources/acceleratorTypes/methods/crazyAggregatedList' + id: google.compute.acceleratorTypes + methods: + crazyAggregatedList: + operation: + $ref: 'googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml#/paths/~1projects~1{project}~1aggregated~1acceleratorTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + getLost: + operation: + $ref: 'googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml#/paths/~1projects~1{project}~1zones~1{zone}~1acceleratorTypes~1{acceleratorType}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + crazyList: + operation: + $ref: 'googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml#/paths/~1projects~1{project}~1zones~1{zone}~1acceleratorTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + name: acceleratorTypes + title: acceleratorTypes + addresses: + id: google.compute.addresses + methods: + aggregatedList: + operation: + $ref: 'googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml#/paths/~1projects~1{project}~1aggregated~1addresses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: 'googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml#/paths/~1projects~1{project}~1regions~1{region}~1addresses~1{address}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: 'googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml#/paths/~1projects~1{project}~1regions~1{region}~1addresses~1{address}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: 'googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml#/paths/~1projects~1{project}~1regions~1{region}~1addresses/post' + request: + mediaType: application/json + required: + - name + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: 'googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml#/paths/~1projects~1{project}~1regions~1{region}~1addresses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + name: addresses + title: addresses diff --git a/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/services-split/compute/compute-disks-v1.yaml b/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/services-split/compute/compute-disks-v1.yaml new file mode 100644 index 00000000..91342a74 --- /dev/null +++ b/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/services-split/compute/compute-disks-v1.yaml @@ -0,0 +1,28108 @@ + + +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://localhost:1080/ +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/registry-verb-matching-src/googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml b/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml new file mode 100644 index 00000000..38092e03 --- /dev/null +++ b/test/registry/registry-verb-matching-src/googleapis.com/v2.0.1/services-split/compute/compute-v1.yaml @@ -0,0 +1,68679 @@ +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: + /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://localhost:1080/ +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